Pythonのretってなんですか

Question

import numpy as np
import cv2

cap = cv2.VideoCapture(0)

while(True):
    # Capture frame-by-frame
    ret, frame = cap.read()

    # Our operations on the frame come here
    gray = cv2.cvtColor(frame, cv2.COLOR_BGR2GRAY)

    # Display the resulting frame
    cv2.imshow('frame',gray)
    if cv2.waitKey(1) & 0xFF == ord('q'):
        break

# When everything done, release the capture
cap.release()
cv2.destroyAllWindows()

opencvを使用したコードなのですが、ループ内で登場するretはどのような役割があるのですか？

Answer 1

osashimiさんはCを書けるようですので、その前提で回答します。

OpenCVに関する情報を集める際は、C++のリファレンスに当たるのが一番早いです。
もちろん100％の信頼は置けませんが、かなりアタリを付けることが出来ます。
OpenCV 3.2.0: cv::VideoCapture Class Reference - § read()

read()
virtual bool cv::VideoCapture::read(OutputArray image)

---

Grabs, decodes and returns the next video frame.

Parameters
[out] image the video frame is returned here. If no frames has been grabbed the image will be empty.
Returns
false if no frames has been grabbed

多少インタフェースは異なりますが、retがこの戻り値に当たることはわかります。

---

なお、Pythonの対話環境上でも、組み込み関数helpで簡単に使い方を見られます。

>>> import cv2
>>> help(cv2.VideoCapture().read)
Help on built-in function read:

read(...) method of cv2.VideoCapture instance
    read([, image]) -> retval, image
    .   @brief Grabs, decodes and returns the next video frame.
    .
    .   @param [out] image the video frame is returned here. If no frames has been grabbed the image will be empty.
    .   @return `false` if no frames has been grabbed

[後略]

書いてある内容は上記のリファレンスとほぼ同一ですね。

追記

PythonとC++とでインタフェースが異なる理由
理由は主に三つです。

• Pythonでは、タプルを利用することによって複数のオブジェクトを簡単に返せる。

C++で同様のことをしようと思うと、そのためだけに構造体などを利用せねばなりません。

• PythonはGCを採用しており、オブジェクトの寿命について考える必要がほとんどない。

C++ではオブジェクトのスコープを意識しないでコードを書くのは不可能です。

• Pythonでは、意識せずともオブジェクトの移行が軽量。

C++ではデフォルトの値の移行がフルコピーであり、意図せず重くなることがあります。

よって、複数のオブジェクトが返される必要がある場合...

• C++では、引数を参照で受け取って書き換えることが多いです。
• Pythonでは、オブジェクトをタプルで返すことが多いです。

C++も、C++11の登場以降かなり近代的なコードを書けるようになりました。
しかし、開発者間でそのような機能が完全に周知浸透しているかと言うと微妙です。

まあ、お手軽にサクサクかけるのがPythonであることは間違いないと思います。

---

Python寄りの意見を書いていますが、私はどちらかと言うとC++の方が好きだったりします。
もちろん上記三つの問題点はC++でも解決可能です。ちょっと難解なだけで。

Comments

[osashimi]

videocaptureの部分ではなく、retが何なのかという事が現在の疑問です。
この場合、frame =　だけでは行けないのでしょうか？

[LouiS0616]

上記の戻り値がretに当たります。
`false` if no frames has been grabbed　rkhsさんが回答されている内容が書かれています。
それとも、retを受け取りたくないという趣旨なのでしょうか？

[osashimi]

ありがとうございます。
私が少し勘違いをしていました。

Answer 2

import cv2

cap = cv2.VideoCapture(0)
print(cap.read())

としたときに出てくる出力は下のような構造になっています。

(<True or False>, <イメージデータ>)

これを二つの変数に格納する際には次のようにします。

import cv2

cap = cv2.VideoCapture(0)
print(cap.read())
<任意の変数名1(<True or False>が代入される)>, <任意の変数名2(<イメージデータ>が代入される)> = cap.read()

以上のことを言い換えると、

ret, frame = cap.read()

の"ret"と"frame"はそれぞれ変数名であることが分かります。
以上より、この変数名はopencv内で定義されたものではなく、
プログラムを書いた人が勝手に付けた変数名です。

長文大変失礼しました。

Comments

[consomme67]

疑問に対してドンピシャでした
ありがとうございます…！

Answer 3

このコードを書いた人が付けたオブジェクト名であり、Pythonの予約語ではありません。

Answer 4

"ret"は,cap.read()でフレームが正しく読み込めたかどうかを教えてくれるフラグです。

Comments

[osashimi]

retはインポートしたcv2に依るものですか？

[WathMorks]

依存しません。