配列操作 ============ .. highlight:: python .. index:: AbsDiff cv::AbsDiff ----------- .. function:: AbsDiff(src1,src2,dst)-> None 2つの配列の要素毎に差の絶対値を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,2つの配列の要素毎に差の絶対値を求めます. .. math:: \texttt{dst} (i)_c = | \texttt{src1} (I)_c - \texttt{src2} (I)_c| すべての入力配列は,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: AbsDiffS cv::AbsDiffS ------------ .. function:: AbsDiffS(src,value,dst)-> None 配列の要素とスカラー値の差の絶対値を求めます. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param value: スカラー値 :type value: :class:`CvScalar` この関数は,入力配列の要素とスカラー値の差の絶対値を求めます. .. math:: \texttt{dst} (i)_c = | \texttt{src} (I)_c - \texttt{value} _c| すべての入力配列は,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: Add cv::Add ------- .. function:: Add(src1,src2,dst,mask=NULL)-> None 2つの配列を要素毎に加算する. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,以下のように1つの配列をもう1つの配列と足し合わせます: :: dst(I)=src1(I)+src2(I) if mask(I)!=0 .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: AddS cv::AddS -------- .. function:: AddS(src,value,dst,mask=NULL)-> None 配列とスカラー値を加算します. :param src: 入力配列 :type src: :class:`CvArr` :param value: 加えられるスカラー値 :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー ``value`` を入力配列 ``src1`` の各要素に加え,その結果を ``dst`` に出力します. また,有限の範囲に値をとる型は,この処理により飽和します. :: dst(I)=src(I)+value if mask(I)!=0 .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: AddWeighted cv::AddWeighted --------------- .. function:: AddWeighted(src1,alpha,src2,beta,gamma,dst)-> None 2つの配列の重み付き和を求めます. :param src1: 1番目の入力配列 :type src1: :class:`CvArr` :param alpha: 1番目の配列要素に対する重み :type alpha: float :param src2: 2番目の入力配列 :type src2: :class:`CvArr` :param beta: 2番目の配列要素に対する重み :type beta: float :param dst: 出力配列 :type dst: :class:`CvArr` :param gamma: 各加算結果にさらに加えられるスカラー値 :type gamma: float この関数は,以下のように2つの配列の重み付き和を計算します: :: dst(I)=src1(I)*alpha+src2(I)*beta+gamma .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: And cv::And ------- .. function:: And(src1,src2,dst,mask=NULL)-> None 2つの配列の要素毎に,ビット単位の論理積を求めます. :param src1: 1番目の入力配列 :type src1: :class:`CvArr` :param src2: 2番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,2つの配列の要素ごとに,ビット単位の論理積を計算します: :: dst(I)=src1(I)&src2(I) if mask(I)!=0 .. 浮動小数点型配列の場合,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけない. .. index:: AndS cv::AndS -------- .. function:: AndS(src,value,dst,mask=NULL)-> None スカラー値と配列の要素毎に,ビット単位の論理積を求めます. :param src: 入力配列 :type src: :class:`CvArr` :param value: スカラー値 :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー値と配列要素毎に,ビット単位の論理積を計算します: :: dst(I)=src(I)&value if mask(I)!=0 .. 実際の計算の前に,スカラー値は配列と同じ型に変換されます.また,浮動小数点型配列の場合は,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: Avg cv::Avg ------- .. function:: Avg(arr,mask=NULL)-> CvScalar 配列の要素の平均値を求めます. :param arr: 配列 :type arr: :class:`CvArr` :param mask: オプションである処理マスク :type mask: :class:`CvArr` この関数は,各チャンネル毎に配列要素値の平均 ``M`` を求めます: .. math:: \begin{array}{l} N = \sum _I ( \texttt{mask} (I) \ne 0) \\ M_c = \frac{\sum_{I, \, \texttt{mask}(I) \ne 0} \texttt{arr} (I)_c}{N} \end{array} 配列が ``IplImage`` で COI が設定されている場合,この関数は指定されたチャンネルのみを処理し,その結果を戻り値の ``CvScalar`` の1番目の要素 :math:`S_0` に格納します. .. index:: AvgSdv cv::AvgSdv ---------- .. function:: AvgSdv(arr,mask=NULL)-> (mean, stdDev) 配列の要素の平均値と標準偏差を求めます. :param arr: 配列 :type arr: :class:`CvArr` :param mask: オプションである処理マスク :type mask: :class:`CvArr` :param mean: 平均値,CvScalar :type mean: :class:`CvScalar` :param stdDev: 標準偏差,CvScalar :type stdDev: :class:`CvScalar` この関数は,各チャンネルごとに配列要素の平均値と標準偏差を求めます: .. math:: \begin{array}{l} N = \sum _I ( \texttt{mask} (I) \ne 0) \\ mean_c = \frac{1}{N} \, \sum _{ I, \, \texttt{mask} (I) \ne 0} \texttt{arr} (I)_c \\ stdDev_c = \sqrt{\frac{1}{N} \, \sum_{ I, \, \texttt{mask}(I) \ne 0} ( \texttt{arr} (I)_c - mean_c)^2} \end{array} 配列が ``IplImage`` で COI が設定されている場合,この関数は指定されたチャンネルのみを処理し,その結果(平均,標準偏差)を出力変数の1番目の要素 :math:`mean_0` , :math:`stdDev_0` に格納します. .. index:: CalcCovarMatrix cv::CalcCovarMatrix ------------------- .. function:: CalcCovarMatrix(vects,covMat,avg,flags)-> None ベクトル集合の分散共分散行列を求めます. :param vects: 入力ベクトルの配列,これらのベクトルは全て同じ型,同じサイズでなければいけません.ベクトルは1次元である必要はなく,2次元(例えば,画像)などでも構いません :type vects: :class:`cvarr_count` :param covMat: 出力である分散共分散行列,浮動小数点型で正方な行列でなければいけません :type covMat: :class:`CvArr` :param avg: 入力あるいは出力(flags に依存する)配列 - 入力ベクトルの平均ベクトル :type avg: :class:`CvArr` :param flags: 処理フラグ.以下の値の組み合わせ * **CV_COVAR_SCRAMBLED** 分散共分散行列が以下のように計算されます: .. math:: \texttt{scale} * [ \texttt{vects} [0]- \texttt{avg} , \texttt{vects} [1]- \texttt{avg} ,...]^T \cdot [ \texttt{vects} [0]- \texttt{avg} , \texttt{vects} [1]- \texttt{avg} ,...] , つまり,分散共分散行列は :math:`\texttt{count} \times \texttt{count}` の行列となります.このような一般的ではない分散共分散行列は,非常に大きなベクトル集合に対する高速なPCAのために利用されます(例えば,顔認識のための固有顔).この「スクランブルされた」行列の固有値は,真の分散共分散行列の固有値と一致します.また,「真の」固有ベクトルは「スクランブルされた」分散共分散行列の固有ベクトルから容易に求めることができます * **CV_COVAR_NORMAL** 分散共分散行列が以下のように計算されます: .. math:: \texttt{scale} * [ \texttt{vects} [0]- \texttt{avg} , \texttt{vects} [1]- \texttt{avg} ,...] \cdot [ \texttt{vects} [0]- \texttt{avg} , \texttt{vects} [1]- \texttt{avg} ,...]^T , つまり, ``covMat`` は各入力ベクトルの要素数と同じ次数をもつ通常の分散共分散行列となります. ``CV_COVAR_SCRAMBLED`` と ``CV_COVAR_NORMAL`` のどちらかは必ず指定される必要があります * **CV_COVAR_USE_AVG** このフラグが指定された場合,平均 ``avg`` を計算せずに,代わりに ``avg`` で指定された平均ベクトルを用います.これは,平均 ``avg`` が何らかの方法で既に計算されている場合や,分散共分散行列が部分的に計算されている場合(この場合も ``avg`` は入力ベクトルの一部の平均ではなく,すべてのベクトルの平均)に役立ちます * **CV_COVAR_SCALE** このフラグが指定された場合,分散共分散行列はスケーリングされます. ``CV_COVAR_NORMAL`` モードでは ``scale`` は '1./count' となり, ``CV_COVAR_SCRAMBLED`` モードでは, ``scale`` は入力ベクトルの要素数の逆数となります.デフォルト(このフラグが指定されない場合)では,分散共分散行列はスケーリングされません(つまり,'scale=1') * **CV_COVAR_ROWS** すべての入力ベクトルが1つの行列 ``vects[0]`` の行として格納されている状態を表します.この場合, ``count`` は無視され, ``avg`` は適切なサイズの1チャンネル行ベクトルでなければいけません * **CV_COVAR_COLS** すべての入力ベクトルが1つの行列 ``vects[0]`` の列として格納されている状態を表します.この場合, ``count`` は無視され, ``avg`` は適切なサイズの1チャンネル列ベクトルでなければいけません :type flags: int この関数は,分散共分散行列を求め,必要ならば入力ベクトル集合の平均ベクトルも計算します. これは,PCA や マハラノビス距離によるベクトル同士の比較などに用いられます. .. index:: CartToPolar cv::CartToPolar --------------- .. function:: CartToPolar(x,y,magnitude,angle=NULL,angleInDegrees=0)-> None 2次元ベクトルの大きさと角度を求めます. :param x: x 座標の配列 :type x: :class:`CvArr` :param y: y 座標の配列 :type y: :class:`CvArr` :param magnitude: 入力ベクトルの大きさを代入する出力配列,大きさが不要ならば NULL がセットされます :type magnitude: :class:`CvArr` :param angle: 入力ベクトルの角度を代入する出力配列,角度が不要ならば NULL がセットされます.角度はラジアン( :math:`0` から :math:`2 \pi` ),または度( :math:`0` から :math:`360` )で表されます :type angle: :class:`CvArr` :param angleInDegrees: 出力である角度をデフォルトの「ラジアン」で表現するか,あるいは「度」で表現するかを指定するフラグ :type angleInDegrees: int この関数は,各2次元ベクトル (x(I),y(I)) の大きさと角度を求めます: :: magnitude(I)=sqrt(x(I)^2^+y(I)^2^ ), angle(I)=atan(y(I)/x(I) ) .. この角度は,0.1 度の精度で計算されます.また,(0,0) の点では,角度は 0 にセットされます. .. index:: Cbrt cv::Cbrt -------- .. function:: Cbrt(value)-> float 立方根を求めます. :param value: 浮動小数点型の入力値 :type value: float この関数は,引数で与えられた入力値の立方根を求めます.また通常, ``pow(value,1./3`` よりも高速であり,負の入力値も適切に扱うことができます.しかし,特別な値( :math:`\pm \infty` , NaN )は扱うことができません. .. index:: ClearND cv::ClearND ----------- .. function:: ClearND(arr,idx)-> None 指定された配列要素をクリアします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx: 要素を指定するインデックスの配列 :type idx: sequence of int 関数 :ref:`ClearND` は,密な配列および疎な配列の指定された要素をクリア(値に0をセット)します.指定された要素が存在しなければ何もしません. .. index:: CloneImage cv::CloneImage -------------- .. function:: CloneImage(image)-> copy ヘッダ,データ,ROIを含む,画像の完全なコピーを作成します. :param image: オリジナル画像 :type image: :class:`IplImage` 戻り値の ``IplImage*`` は,コピーされた画像へのポインタです. .. index:: CloneMat cv::CloneMat ------------ .. function:: CloneMat(mat)-> copy 行列の完全なコピーを作成します. :param mat: コピーされる行列 :type mat: :class:`CvMat` 行列の完全なコピーを作成し,そのコピーへのポインタを返します. .. index:: CloneMatND cv::CloneMatND -------------- .. function:: CloneMatND(mat)-> copy 多次元の配列の完全なコピーを作成し,そのポインタを返します. :param mat: 入力配列 :type mat: :class:`CvMatND` .. index:: Cmp cv::Cmp ------- .. function:: Cmp(src1,src2,dst,cmpOp)-> None 2つの配列の要素毎の比較を行います. :param src1: 1番目の入力配列 :type src1: :class:`CvArr` :param src2: 2番目の入力配列.入力配列は,どちらもシングルチャンネルでなければいけません :type src2: :class:`CvArr` :param dst: 出力配列,8u か 8s 型でなければいけません :type dst: :class:`CvArr` :param CmpOp: 要素同士の関係を指定するフラグ * **CV_CMP_EQ** src1(I) は src2(I) "と等しい" * **CV_CMP_GT** src1(I) は src2(I) "より大きい" * **CV_CMP_GE** src1(I) は src2(I) "以上" * **CV_CMP_LT** src1(I) は src2(I) "より小さい" * **CV_CMP_LE** src1(I) は src2(I) "以下" * **CV_CMP_NE** src1(I) は src2(I) "と等しくない" この関数は,2つの配列の対応する2つの要素同士を比較し,その結果に応じた値でマスク配列を埋めます: :: dst(I)=src1(I) op src2(I), .. 比較結果が真であれば, ``dst(I)`` に 0xff(全てのビットが ``1`` )がセットされ,そうでなければ 0 がセットされます.出力配列を除くすべての入力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: CmpS cv::CmpS -------- .. function:: CmpS(src,value,dst,cmpOp)-> None スカラー値と配列の要素毎の比較を行います. :param src: 入力配列,シングルチャンネルでなければいけません :type src: :class:`CvArr` :param value: 入力配列の各要素と比較されるスカラー値 :type value: float :param dst: 出力配列,8u か 8s 型でなければいけません :type dst: :class:`CvArr` :param cmpOp: 要素同士の関係を指定するフラグ * **CV_CMP_EQ** src1(I) は value "と等しい" * **CV_CMP_GT** src1(I) は value "より大きい" * **CV_CMP_GE** src1(I) は value "以上" * **CV_CMP_LT** src1(I) は value "より小さい" * **CV_CMP_LE** src1(I) は value "以下" * **CV_CMP_NE** src1(I) は value "と等しくない" :type cmpOp: int この関数は,配列の要素とスカラー値を比較し,その結果に応じた値でマスク配列を埋めます: :: dst(I)=src(I) op scalar .. ここで ``op`` は :math:`=` , :math:`>` , :math:`\ge` , :math:`<` , :math:`\le` , :math:`\ne` のいずれかです. 比較結果が真であれば, ``dst(I)`` に 0xff(全てのビットが ``1`` )がセットされ,そうでなければ 0 がセットされます.出力配列を除くすべての入力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: Convert cv::Convert ----------- .. function:: Convert(src,dst)-> None ある配列を別の配列に変換します. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` 変換の種類には,まるめ演算を行うものと飽和演算を行うものがあります.つまり,スケーリング + 変換の結果が,出力配列要素の型で厳密に表現できない場合,最も近い実数軸上の値で代替されます. マルチチャンネル配列のすべてのチャンネルは,個別に処理されます. .. index:: ConvertScale cv::ConvertScale ---------------- .. function:: ConvertScale(src,dst,scale=1.0,shift=0.0)-> None 配列に対して任意の線形変換を行います. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param scale: スケール係数 :type scale: float :param shift: スケーリングされた入力配列要素に加えられる値 :type shift: float 関数 ``cvConvertScale`` は,複数の異なる使用目的に応じた,複数の別名をもちます.この関数は,入力配列に対して任意のスケーリングと任意の変換(あるいは任意の変換のみ)を行い,結果を出力配列にコピーします: .. math:: \texttt{dst} (I) = \texttt{scale} \texttt{src} (I) + ( \texttt{shift} _0, \texttt{shift} _1,...) マルチチャンネル配列のチャンネルはすべて,個別に処理されます. 変換の種類によっては,丸めや飽和を伴う場合があります.つまり,スケーリング+変換の結果が,出力配列の要素の型で正確に表現できない場合,実軸上でもっとも近い表現可能な値が出力として用いられます. ``scale=1, shift=0`` の場合には,スケーリングは行われません.これは,特別に最適化されたケースであり,適切な別名 :ref:`Convert` を持ちます.入出力配列が同じ種類である場合も,行列や画像のスケーリングや移動を行うことができる特別なケースであり, :ref:`Scale` と呼ばれます. .. index:: ConvertScaleAbs cv::ConvertScaleAbs ------------------- .. function:: ConvertScaleAbs(src,dst,scale=1.0,shift=0.0)-> None 入力配列の要素を,任意の線形変換によって8ビット符号なし整数に変換します. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列(ビット深度は 8u) :type dst: :class:`CvArr` :param scale: 絶対値スケール係数 :type scale: float :param shift: スケーリングされた入力配列要素に加えられる値 :type shift: float この関数は, :ref:`ConvertScale` と似ていますが,変換結果の絶対値を保存します. .. math:: \texttt{dst} (I) = | \texttt{scale} \texttt{src} (I) + ( \texttt{shift} _0, \texttt{shift} _1,...)| この関数は,8u(8-ビット,符号なし整数)型の出力配列のみをサポートします. その他の型の場合は, :ref:`ConvertScale` と :ref:`Abs` の組み合わせることで,この関数をエミュレートできます. .. index:: CvtScaleAbs cv::CvtScaleAbs --------------- .. function:: CvtScaleAbs(src,dst,scale=1.0,shift=0.0)-> None 入力配列の要素を,別の 8-ビット,符号なし整数に変換します.オプションで,さらに線形変換を行うこともできます. :param src: 入力配列 :param dst: 出力配列(ビット深度は 8u でなければいけません) :param scale: ScaleAbs ファクタ :param shift: スケーリングされた入力配列要素に足される値 この関数は, :ref:`ConvertScale` と似ていますが,変換結果の絶対値を出力します: .. math:: \texttt{dst} (I) = | \texttt{scale} \texttt{src} (I) + ( \texttt{shift} _0, \texttt{shift} _1,...)| この関数は,出力配列として8u(8ビット符号なし整数)型の配列のみをサポートします.その他の型の場合は, :ref:`ConvertScale` と :ref:`Abs` を組み合わせることで,この関数と同等の結果を得られます. .. index:: Copy cv::Copy -------- .. function:: Copy(src,dst,mask=NULL)-> None 配列をコピーします. :param src: コピー元の配列 :type src: :class:`CvArr` :param dst: コピー先の配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,入力配列の選択された要素を出力配列にコピーします: .. math:: \texttt{dst} (I)= \texttt{src} (I) \quad \text{if} \quad \texttt{mask} (I) \ne 0. 引数配列に ``IplImage`` が含まれる場合,その ROI と COI が利用されます.コピー元配列とコピー先配列は,同じ型,同じ次元,同じサイズでなければいけません.また,この関数は疎な配列もコピーできます(が,その場合マスクはサポートされません). .. index:: CountNonZero cv::CountNonZero ---------------- .. function:: CountNonZero(arr)-> int 配列中の 0 ではない要素を数えます. :param arr: シングルチャンネルの配列,あるいは COI が設定されたマルチチャンネル画像 :type arr: :class:`CvArr` この関数は, ``arr`` 中の 0 ではない要素数を返します: .. math:: \sum _I ( \texttt{arr} (I) \ne 0) ``IplImage`` の場合は,ROI と COI がサポートされます. .. index:: CreateData cv::CreateData -------------- .. function:: CreateData(arr) -> None 配列データ領域を確保します. :param arr: 配列のヘッダ この関数は,画像,行列あるいは多次元配列のデータを確保します.行列の場合は OpenCV の確保関数が用いられます.IplImage の場合も OpenCV の関数が用いられますが, ``CV_TURN_ON_IPL_COMPATIBILITY`` が呼ばれている場合は例外的に,IPL 関数によってデータ領域が確保されます. .. index:: CreateImage cv::CreateImage --------------- .. function:: CreateImage(size, depth, channels)->image 画像ヘッダを作成し,データ領域を確保します. :param size: 画像の幅と高さ :param depth: 画像のビット深度.有効な値は, :ref:`IplImage` を参照してください :param channels: ピクセル毎のチャンネル数.詳しくは :ref:`IplImage` を参照してください.この関数は,インタリーブチャンネルの画像のみを作成できます .. index:: CreateImageHeader cv::CreateImageHeader --------------------- .. function:: CreateImageHeader(size, depth, channels) -> image 画像ヘッダを作成しますが,データ領域の確保は行いません. :param size: 画像の幅と高さ :param depth: ビット深度( :ref:`CreateImage` を参照してください) :param channels: チャンネル数( :ref:`CreateImage` を参照してください) .. index:: CreateMat cv::CreateMat ------------- .. function:: CreateMat(rows, cols, type) -> mat 行列のヘッダを作成し,データ領域を確保します. :param rows: 行列の行数 :param cols: 行列の列数 :param type: ``CV_C`` で表される,行列の要素の型.ここで,S=signed:符号あり,U=unsigned:符号なし,F=float:浮動小数点型,をそれぞれ表します.例えば CV _ 8UC1 は,8ビット符号なしでシングルチャンネルの要素を意味し,CV _ 32SC2 は,32ビット符号ありで2チャンネルの要素を意味します .. index:: CreateMatHeader cv::CreateMatHeader ------------------- .. function:: CreateMatHeader(rows, cols, type) -> mat 行列のデータ領域を確保せずに,行列のヘッダのみを作成します. :param rows: 行列の行数 :param cols: 行列の列数 :param type: 行列の要素の種類, :ref:`CreateMat` を参照してください この関数は,新しい行列のヘッダを作成し,そのポインタを返します.行列データは, :ref:`CreateData` を用いて確保するか,あるいは,ユーザが確保したデータを :ref:`SetData` によって明示的にセットします. .. index:: CreateMatND cv::CreateMatND --------------- .. function:: CreateMatND(dims, type) -> None 多次元の密な配列のヘッダを作成し,データ領域を確保します. :param dims: 長さ32以下の,配列の次元のリスト,またはタプル :param type: 配列の要素の種類, :ref:`CreateMat` を参照してください これは,以下の形式を短縮したものです: .. index:: CreateMatNDHeader cv::CreateMatNDHeader --------------------- .. function:: CreateMatNDHeader(dims, type) -> None 行列のデータ領域を確保せずに,行列のヘッダのみを作成します. :param dims: 長さ32以下の,配列の次元のリスト,またはタプル :param type: 配列の要素の種類, :ref:`CreateMat` を参照してください この関数は,多次元の密な配列のヘッダを確保します.配列データは, :ref:`CreateData` を用いて確保するか,あるいは,ユーザが確保したデータを :ref:`SetData` によって明示的にセットします. .. index:: CrossProduct cv::CrossProduct ---------------- .. function:: CrossProduct(src1,src2,dst)-> None 2つの3次元ベクトルの外積を求めます. :param src1: 1番目の入力ベクトル :type src1: :class:`CvArr` :param src2: 2番目の入力ベクトル :type src2: :class:`CvArr` :param dst: 出力ベクトル :type dst: :class:`CvArr` この関数は,2つの3次元ベクトルの外積を求めます: .. math:: \texttt{dst} = \texttt{src1} \times \texttt{src2} あるいは: .. math:: \begin{array}{l} \texttt{dst} _1 = \texttt{src1} _2 \texttt{src2} _3 - \texttt{src1} _3 \texttt{src2} _2 \\ \texttt{dst} _2 = \texttt{src1} _3 \texttt{src2} _1 - \texttt{src1} _1 \texttt{src2} _3 \\ \texttt{dst} _3 = \texttt{src1} _1 \texttt{src2} _2 - \texttt{src1} _2 \texttt{src2} _1 \end{array} CvtPixToPlane ------------- :ref:`Split` と同義です. .. index:: DCT cv::DCT ------- .. function:: DCT(src,dst,flags)-> None 1次元あるいは2次元浮動小数点型配列に対して,離散コサイン変換(DCT),逆離散コサイン変換(IDCT)を行います. :param src: 入力配列,1次元配列または2次元の,実数の配列 :type src: :class:`CvArr` :param dst: 出力配列,入力配列と同じサイズ,同じ型 :type dst: :class:`CvArr` :param flags: 変換フラグ,以下の値の組み合わせ: * **CV_DXT_FORWARD** 1次元あるいは2次元の順変換を行います * **CV_DXT_INVERSE** 1次元あるいは2次元の逆変換を行います * **CV_DXT_ROWS** 入力配列のそれぞれの行に対して独立に,順変換あるいは逆変換を行います.このフラグによって,複数ベクトルの同時変換が可能になります.また,オーバーヘッド(ベクトルが大量にあると,計算自体の何倍も時間がかかることもあります)を減らし,3次以上の高次元に対して変換を行うことができるようになります :type flags: int この関数は,1次元あるいは 2次元浮動小数点型配列に対して,離散コサイン変換,逆離散コサイン変換を行います. N 個の要素を持つ 1 次元ベクトルに対するコサイン変換: .. math:: Y = C^{(N)} \cdot X ここで .. math:: C^{(N)}_{jk}= \sqrt{\alpha_j/N} \cos \left ( \frac{\pi(2k+1)j}{2N} \right ) および :math:`\alpha_0=1` , :math:`\alpha_j=2` for :math:`j > 0` です. N 個の要素を持つ 1 次元ベクトルに対する逆コサイン変換: .. math:: X = \left (C^{(N)} \right )^{-1} \cdot Y = \left (C^{(N)} \right )^T \cdot Y ( :math:`C^{(N)}` は直行行列なので, :math:`C^{(N)} \cdot \left(C^{(N)}\right)^T = I` ) :math:`M \times N` の2 次元行列に対するコサイン変換: .. math:: Y = C^{(N)} \cdot X \cdot \left (C^{(N)} \right )^T :math:`M \times N` 個の要素を持つ2 次元ベクトルに対する逆コサイン変換: .. math:: X = \left (C^{(N)} \right )^T \cdot X \cdot C^{(N)} .. index:: DFT cv::DFT ------- .. function:: DFT(src,dst,flags,nonzeroRows=0)-> None 1 次元あるいは 2 次元浮動小数点型配列に対して,離散フーリエ変換(DFT),逆離散フーリエ変換(IDFT)を行います. :param src: 入力配列,実数あるいは複素数 :type src: :class:`CvArr` :param dst: 出力配列,入力配列と同じサイズ,同じ型 :type dst: :class:`CvArr` :param flags: 変換フラグ,以下の値の組み合わせ: * **CV_DXT_FORWARD** 1次元または2次元の順変換を行います.結果のスケーリングは行われません * **CV_DXT_INVERSE** 1次元または2次元の逆変換を行います.結果のスケーリングは行われません. ``CV_DXT_FORWARD`` と ``CV_DXT_INVERSE`` は,もちろん同時には指定できません * **CV_DXT_SCALE** 結果を配列要素数で割ってスケーリングします.通常は ``CV_DXT_INVERSE`` と同時に用います.これのショートカットとして ``CV_DXT_INV_SCALE`` を用いても構いません * **CV_DXT_ROWS** 入力配列のそれぞれの行に対して独立に,順変換あるいは逆変換を行います.このフラグによって,複数ベクトルの同時変換が可能になります.また,オーバーヘッド(ベクトルが大量にあると,計算自体の何倍も時間がかかることもあります)を減らし,3次以上の高次元に対して変換を行うことができるようになります * **CV_DXT_INVERSE_SCALE** ``CV_DXT_INVERSE + CV_DXT_SCALE`` と等価 :type flags: int :param nonzeroRows: 入力配列中で,0 ではない行の数(2次元順変換の場合),あるいは出力配列中の注目する行の数(2次元逆変換の場合).値が0以下の場合,あるいは行の総数よりも大きい場合は,この引数は無視されます.このパラメータを指定すると,DFT を利用して2次元の畳み込みや相関演算を高速に行うことができます.詳しくは,以下のサンプルを参照してください :type nonzeroRows: int この関数は,1 次元あるいは 2 次元浮動小数点型配列に対して,離散フーリエ変換,逆離散フーリエ変換を行います: N 個の要素を持つ 1 次元ベクトルに対するフーリエ変換: .. math:: y = F^{(N)} \cdot x, where F^{(N)}_{jk}=exp(-i \cdot 2 \pi \cdot j \cdot k/N) , .. math:: i=sqrt(-1) N 個の要素を持つ 1 次元ベクトルに対する逆フーリエ変換: .. math:: x'= (F^{(N)})^{-1} \cdot y = conj(F^(N)) \cdot y x = (1/N) \cdot x M :math:`\times` N 個の要素を持つ 2 次元ベクトルに対するフーリエ変換: .. math:: Y = F^{(M)} \cdot X \cdot F^{(N)} M :math:`\times` N 個の要素を持つ 2 次元ベクトルに対する逆フーリエ変換: .. math:: X'= conj(F^{(M)}) \cdot Y \cdot conj(F^{(N)}) X = (1/(M \cdot N)) \cdot X' 実数データ(シングルチャンネル)の場合,フーリエ変換の出力や逆変換の入力を表現するために,IPL 形式の packed フォーマットが用いられます: .. math:: \begin{bmatrix} Re Y_{0,0} & Re Y_{0,1} & Im Y_{0,1} & Re Y_{0,2} & Im Y_{0,2} & \cdots & Re Y_{0,N/2-1} & Im Y_{0,N/2-1} & Re Y_{0,N/2} \\ Re Y_{1,0} & Re Y_{1,1} & Im Y_{1,1} & Re Y_{1,2} & Im Y_{1,2} & \cdots & Re Y_{1,N/2-1} & Im Y_{1,N/2-1} & Re Y_{1,N/2} \\ Im Y_{1,0} & Re Y_{2,1} & Im Y_{2,1} & Re Y_{2,2} & Im Y_{2,2} & \cdots & Re Y_{2,N/2-1} & Im Y_{2,N/2-1} & Im Y_{1,N/2} \\ \hdotsfor{9} \\ Re Y_{M/2-1,0} & Re Y_{M-3,1} & Im Y_{M-3,1} & \hdotsfor{3} & Re Y_{M-3,N/2-1} & Im Y_{M-3,N/2-1}& Re Y_{M/2-1,N/2} \\ Im Y_{M/2-1,0} & Re Y_{M-2,1} & Im Y_{M-2,1} & \hdotsfor{3} & Re Y_{M-2,N/2-1} & Im Y_{M-2,N/2-1}& Im Y_{M/2-1,N/2} \\ Re Y_{M/2,0} & Re Y_{M-1,1} & Im Y_{M-1,1} & \hdotsfor{3} & Re Y_{M-1,N/2-1} & Im Y_{M-1,N/2-1}& Re Y_{M/2,N/2} \end{bmatrix} 注意: ``N`` が偶数ならば最終列が存在し, ``M`` が偶数ならば最終行が存在します. また,1次元実数データを変換する場合,その結果は上述の行列の1行目のようになります. ここでは,DFTを用いた2次元畳み込演算の例を示します. .. index:: Det cv::Det ------- .. function:: Det(mat)-> double 行列式を返します. :param mat: 入力行列 :type mat: :class:`CvArr` 関数 ``cvDet`` は,正方行列 ``mat`` の行列式を返します.小さい行列には直接的な方法が,大きい行列にはガウスの消去法が用いられます.正定値対称行列の場合は, :math:`U = V = 0` として :ref:`SVD` を行い, :math:`W` の対角要素の積として行列式を計算することもできます. .. index:: Div cv::Div ------- .. function:: Div(src1,src2,dst,scale)-> None 2つの配列の要素毎の割り算を行います. :param src1: 1 番目の入力配列.これが NULL の場合,配列は全ての要素が1であると仮定されます :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param scale: オプションであるスケール係数 :type scale: float この関数は,1つの配列をもう1つの配列で割ります: .. math:: \texttt{dst} (I)= \fork{\texttt{scale} \cdot \texttt{src1}(I)/\texttt{src2}(I)}{if \texttt{src1} is not \texttt{NULL}}{\texttt{scale}/\texttt{src2}(I)}{otherwise} すべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: DotProduct cv::DotProduct -------------- .. function:: DotProduct(src1,src2)-> double 2つの配列のユークリッド内積を計算します. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` この関数は,2つの配列のユークリッド内積を計算して返します. .. math:: src1 \bullet src2 = \sum _I ( \texttt{src1} (I) \texttt{src2} (I)) マルチチャンネル配列の場合,全てのチャンネルの結果が足し合わされます.特に, ``cvDotProduct(a,a)`` ( ``a`` は複素ベクトル)の場合は :math:`||\texttt{a}||^2` を返します. この関数は,多次元配列を,行毎,レイヤー毎,に処理することができます. .. index:: EigenVV cv::EigenVV ----------- .. function:: EigenVV(mat,evects,evals,eps,lowindex,highindex)-> None 対称行列の固有値と固有ベクトルを求めます. :param mat: 入力となる対称行列,関数の処理中に値が変更されます :type mat: :class:`CvArr` :param evects: 固有ベクトルを表す出力行列,ベクトルは連続した行として格納されます :type evects: :class:`CvArr` :param evals: 固有値を表す出力ベクトル,値は降順に格納されます(もちろん,固有値と固有ベクトルの順番は一致します) :type evals: :class:`CvArr` :param eps: 対角化の精度.一般的に, ``DBL_EPSILON`` (約 :math:`10^{-15}` ) で十分です.このパラメータは,現在は無視されます :type eps: float :param lowindex: オプション.計算される最大の固有値/固有ベクトルのインデックス(下記を参照してください) :type lowindex: int :param highindex: オプション.計算される最小の固有値/固有ベクトルのインデックス(下記を参照してください) :type highindex: int この関数は,行列 ``A`` の固有値と固有ベクトルを求めます: :: mat*evects(i,:)' = evals(i)*evects(i,:)' (in MATLAB notation) .. lowindex あるいは highindex の一方が与えられると,もう片方も必要になります.また,このインデックスは,0から始まります. 例えば,最大の固有値/固有ベクトルを計算する場合は, ``lowindex=highindex=0`` をセットします. また,すべての固有値を計算する場合は, ``lowindex=highindex=-1`` のままにしておきます. 過去の経緯から,この関数は常に入力行列と同じサイズの正方行列(固有ベクトルから構成)と,入力行列と同じ長さのベクトル(固有値から構成)を返します. インデックスで選択された固有値/固有ベクトルは,常に最初の highindex - lowindex + 1 行目に格納されます. 行列 ``A`` の内容は,この関数によって破壊されます. 今のところ,この関数は :ref:`SVD` よりも遅く,精度も低いです.よって, ``A`` が正定値行列(例えば,分散共分散行列など)であることが既知である場合に,その固有値と固有ベクトルを計算するには(固有ベクトルが必要とされない場合は特に) :ref:`SVD` を用いることが推奨されます. .. index:: Exp cv::Exp ------- .. function:: Exp(src,dst)-> None 各配列要素を指数として,自然対数の底(ネイピア数)eのべき乗を求めます. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列, ``double`` 型,あるいは入力配列と同じ型 :type dst: :class:`CvArr` この関数は,入力配列の各要素に対して,それを指数とする自然対数の底eのべき乗を求めます: .. math:: \texttt{dst} [I] = e^{ \texttt{src} (I)} 最大誤差は約 :math:`7 \times 10^{-6}` です.現在の実装では,指数表現されない(非正規化)浮動小数点数は 0 に変換されて出力されます. .. index:: FastArctan cv::FastArctan -------------- .. function:: FastArctan(y,x)-> float 2次元ベクトルの角度を求めます. :param x: 2次元ベクトルのX座標 :type x: float :param y: 2次元ベクトルのy座標 :type y: float 関数 ``cvFastArctan`` は,2次元ベクトルの角度を求めます.この角度は 0 度から 360 度の間に値をとり,精度は約 0.1 度です. .. index:: Flip cv::Flip -------- .. function:: Flip(src,dst=NULL,flipMode=0)-> None 2次元配列を垂直,水平,または両軸で反転します. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列, :math:`\texttt{dst} = \texttt{NULL}` の場合は,置換モード(処理後の値が入力変数に代入される)で反転されます :type dst: :class:`CvArr` :param flip_mode: 配列の反転軸の指定:0 は x-軸周りでの反転,正値(例えば,1)は y-軸周りでの反転,負値(例えば,-1)は 両軸周りでの反転を表します.以下の式と説明も参照してください: この関数は,3種の中から1つ選択された方法で配列を反転させます(行と列のインデックスは0が基準): .. math:: dst(i,j) = \forkthree{\texttt{src}(rows(\texttt{src})-i-1,j)}{if $\texttt{flipMode} = 0$}{\texttt{src}(i,cols(\texttt{src})-j-1)}{if $\texttt{flipMode} > 0$}{\texttt{src}(rows(\texttt{src})-i-1,cols(\texttt{src})-j-1)}{if $\texttt{flipMode} < 0$} この関数が利用されるケースとして,以下のような場合が考えられます: * 左上原点画像と左下原点画像の変換をするための画像の上下反転(flip _ mode = 0).これは,Win32 システム環境下のビデオ画像処理でよく利用されます. * 垂直軸に対する線対称性を調べるための左右反転(flip _ mode :math:`>` 0),反転後に水平シフトして差の絶対値を計算します. * 中心点に対する点対称性を調べるための上下,左右の同時反転(flip _ mode :math:`<` 0),反転後にシフトして差の絶対値を計算します. * 1次元配列の順番を逆転(flip _ mode > 0) .. index:: fromarray cv::fromarray ------------- .. function:: fromarray(object, allowND = False) -> CvMat 配列インタフェースをサポートするオブジェクトから CvMat を作成します. :param object: 配列インタフェースをサポートする任意のオブジェクト :param allowND: これが真の場合, CvMatND が返されます オブジェクトが `配列インタフェース `_ をサポートする場合, :ref:`CvMat` ( ``allowND = False`` ) あるいは :ref:`CvMatND` ( ``allowND = True`` ) が返されます. ``allowND = False`` の場合,オブジェクトの配列は2次元または3次元でなければいけません.2次元の場合,返される CvMat はシングルチャンネルです.3次元の場合,返される CvMat は N チャンネルであり,この N は配列の最大の次元です.この場合,N は OpenCV のチャンネル限界 ``CV_CN_MAX`` よりも大きくなることはできません. ``allowND = True`` の場合, ``fromarray`` は,元の配列と同じ形状でシングルチャンネルの :ref:`CvMatND` を返します. 例えば, `NumPy `_ 配列は配列インタフェースをサポートするので,OpenCV オブジェクトに変換できます: .. doctest:: >>> import cv, numpy >>> a = numpy.ones((480, 640)) >>> mat = cv.fromarray(a) >>> print cv.GetDims(mat), cv.CV_MAT_CN(cv.GetElemType(mat)) (480, 640) 1 >>> a = numpy.ones((480, 640, 3)) >>> mat = cv.fromarray(a) >>> print cv.GetDims(mat), cv.CV_MAT_CN(cv.GetElemType(mat)) (480, 640) 3 >>> a = numpy.ones((480, 640, 3)) >>> mat = cv.fromarray(a, allowND = True) >>> print cv.GetDims(mat), cv.CV_MAT_CN(cv.GetElemType(mat)) (480, 640, 3) 1 .. .. index:: GEMM cv::GEMM -------- .. function:: GEMM(src1,src2,alphs,src3,beta,dst,tABC=0)-> None 汎用的な行列の乗算を行います. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param src3: 3 番目の入力配列(シフト用).もしシフトしない場合は NULLにできます :type src3: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param tABC: 操作フラグ.0 あるいは 以下の値の組み合わせ * **CV_GEMM_A_T** src1 を転置 * **CV_GEMM_B_T** src2 を転置 * **CV_GEMM_C_T** src3 を転置 例えば, ``CV_GEMM_A_T+CV_GEMM_C_T`` は以下に相当します. .. math:: \texttt{alpha} \, \texttt{src1} ^T \, \texttt{src2} + \texttt{beta} \, \texttt{src3} ^T :type tABC: int この関数は,汎用的な行列の乗算を行います: .. math:: \texttt{dst} = \texttt{alpha} \, op( \texttt{src1} ) \, op( \texttt{src2} ) + \texttt{beta} \, op( \texttt{src3} ) \quad \text{where $op(X)$ is $X$ or $X^T$} すべての入力行列は,同じデータ型,適切なサイズでなければいけません.実数あるいは複素数の浮動小数点型の行列がサポートされます. .. index:: Get1D cv::Get1D --------- .. function:: Get1D(arr, idx) -> scalar 特定の配列要素を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx: 要素インデックス.0が基準点 :type idx: int 特定の配列要素を返します.この配列は,1次元でなければいけません. .. index:: Get2D cv::Get2D --------- .. function:: Get2D(arr, idx0, idx1) -> scalar 特定の配列要素を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素の行インデックス.0が基準点 :type idx0: int :param idx1: 要素の列インデックス.0が基準点 :type idx1: int 特定の配列要素を返します.この配列は,2次元でなければいけません. .. index:: Get3D cv::Get3D --------- .. function:: Get3D(arr, idx0, idx1, idx2) -> scalar 特定の配列要素を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素インデックス.0が基準点 :type idx0: int :param idx1: 要素インデックス.0が基準点 :type idx1: int :param idx2: 要素インデックス.0が基準点 :type idx2: int 特定の配列要素を返します.この配列は,3次元でなければいけません. .. index:: GetND cv::GetND --------- .. function:: GetND(arr, indices) -> scalar 特定の配列要素を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param indices: 要素インデックスのリスト.インデックスは,0が基準点 :type indices: sequence of int 特定の配列要素を返します.インデックスリストの長さは,この配列の次元と一致していなければいけません. .. index:: GetCol cv::GetCol ---------- .. function:: GetCol(arr,col)-> submat 配列の列を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param col: 指定列のインデックス.0が基準点 :type col: int :param submat: 結果として得られる,1列の配列 :type submat: :class:`CvMat` 関数 ``GetCol`` は,入力配列の中から1列を返します. .. index:: GetCols cv::GetCols ----------- .. function:: GetCols(arr,startCol,endCol)-> submat 配列中の,指定範囲内の複数列を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param startCol: 指定範囲の最初の(この値を含む)列のインデックス,0が基準点 :type startCol: int :param endCol: 指定範囲の最後の(この値を含まない)列のインデックス,0が基準点 :type endCol: int :param submat: 結果として得られる,複数列配列 :type submat: :class:`CvMat` 関数 ``GetCols`` は,入力配列中の,指定範囲内の複数列を返します. .. index:: GetDiag cv::GetDiag ----------- .. function:: GetDiag(arr,diag=0)-> submat 対角要素の配列を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param submat: 結果として得られる部分配列へのポインタ :type submat: :class:`CvMat` :param diag: 配列の対角を指定.0は主対角列に対応し,-1は主対角列の1つ上の斜め列,1は主対角列の1つ下の斜め列,という様に対応します :type diag: int この関数は,入力配列中の指定された対角要素に対応するヘッダを返します. .. index:: GetDims cv::GetDims ----------- .. function:: GetDims(arr)-> list 配列次元のリストを返します. :param arr: 入力配列 この関数は,入力配列の各次元の要素数を要素とするリストを返します. ``IplImage`` や :ref:`CvMat` の場合は,常に長さ 2 のリストを返します. .. index:: GetElemType cv::GetElemType --------------- .. function:: GetElemType(arr)-> int 配列要素の種類を返します. :param arr: 入力配列 :type arr: :class:`CvArr` この関数は, :ref:`CreateMat` の説明で述べられた配列要素の種類を返します: ``CV_8UC1`` ... ``CV_64FC4`` . .. index:: GetImage cv::GetImage ------------ .. function:: GetImage(arr) -> iplimage 任意の配列に対する画像ヘッダを返します. :param arr: 入力配列 関数 ``cvGetImage`` は,入力配列を画像とみなした場合の画像ヘッダを返します. 入力配列になり得るものは,行列 - :ref:`CvMat` と,画像 - ``IplImage*`` です. 入力が画像の場合は,単に入力ポインタをそのまま返します.入力が :ref:`CvMat` の場合は, ``imageHeader`` 構造体を入力行列のパラメータで初期化します. ROIが設定された ``IplImage`` から :ref:`CvMat` への変換を行い,再び CvMat から IplImage に戻した場合,異なるヘッダが返される可能性があります. したがって,画像の長さをその幅とアライメントから計算するような IPL 関数は,この関数の結果として得られる画像に対しては失敗する可能性があります. .. index:: GetImageCOI cv::GetImageCOI --------------- .. function:: GetImageCOI(image)-> channel COI のインデックスを返します. :param image: 画像ヘッダへのポインタ :type image: :class:`IplImage` IplImage の COI を返します.この戻り値は, :ref:`SetImageCOI` の引数 ``coi`` に対応します. .. index:: GetImageROI cv::GetImageROI --------------- .. function:: GetImageROI(image)-> CvRect 画像の ROI を返します. :param image: 画像ヘッダへのポインタ :type image: :class:`IplImage` ROI が設定されていない場合は,画像全体を表す ``cvRect(0,0,image->width,image->height)`` が返されます. .. index:: GetMat cv::GetMat ---------- .. function:: GetMat(arr, allowND=0) -> cvmat 任意の配列に対する行列ヘッダを返します. :param arr: 入力配列 この関数は,入力配列を行列とみなした場合の行列ヘッダを返します. 入力配列になり得るものは,行列 - :ref:`CvMat` ,画像 - ``IplImage`` ,多次元の密な配列 :ref:`CvMatND` (これは ``allowND != 0`` の場合のみ)です.入力が行列の場合は,単に入力ポインタをそのまま返します. ``IplImage*`` あるいは :ref:`CvMatND` の場合, ``header`` 構造体を現在の画像 ROI のパラメータで初期化し,そのテンポラリ構造体へのポインタを返します. :ref:`CvMat` では COI がサポートされないので,これは別のオプション出力として返されます. この関数によって,2種類の配列( ``IplImage`` と :ref:`CvMat` )を簡単に同じコードで扱うことができます.また,関数 :ref:`GetImage` を用いることで, :ref:`CvMat` から ``IplImage`` への逆変換が可能です. 入力配列には,内部データが確保されている,あるいは関連付けられている必要があります.そうでなければ,この関数は失敗します. 入力配列が平面データレイアウト(2次元RGB画像など)を持ち,COI が設定されている ``IplImage`` である場合,この関数は,選択された平面(例えば,色平面R)へのポインタとCOI=0を返します.OpenCVの関数を用いて,マルチチャンネル画像の各チャンネル(平面)毎に処理を行う事ができるようになります. .. index:: GetOptimalDFTSize cv::GetOptimalDFTSize --------------------- .. function:: GetOptimalDFTSize(size0)-> int 与えられたベクトルサイズに対する最適な DFT サイズを返します. :param size0: ベクトルサイズ :type size0: int この関数は,DFTサイズ ``N`` を返します.この ``N`` は,DFTを高速に実行できるサイズのうちで ``size0`` 以上の最小値です.現在の実装では,ある :math:`p` , :math:`q` , :math:`r` に対して :math:`N=2^p \times 3^q \times 5^r` となっています. ``size0`` が大きすぎる( ``INT_MAX`` に非常に近い)場合,この関数は負の値を返します. .. index:: GetRow cv::GetRow ---------- .. function:: GetRow(arr,row)-> submat 配列の行を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param row: 選択された行のインデックス(0が基準点) :type row: int :param submat: 結果として得られる,1行の配列 :type submat: :class:`CvMat` 関数 ``GetRow`` は,入力配列の中から1行を返します. .. index:: GetRows cv::GetRows ----------- .. function:: GetRows(arr,startRow,endRow,deltaRow=1)-> submat 配列中の,指定範囲内の複数行を返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param startRow: 指定範囲の最初の(この値を含む)行のインデックス,0が基準点 :type startRow: int :param endRow: 指定範囲の最後の(この値を含まない)行のインデックス,0が基準点 :type endRow: int :param deltaRow: 行インデックスの増加ステップ :type deltaRow: int :param submat: 結果として得られる,複数行配列 :type submat: :class:`CvMat` 関数 ``GetRows`` は,入力配列中の,指定範囲内の複数行を返します. .. index:: GetSize cv::GetSize ----------- .. function:: GetSize(arr)-> CvSize 行列あるいは画像ROIのサイズを返します. :param arr: 配列のヘッダ :type arr: :class:`CvArr` この関数は,入力行列あるいは入力画像の行数(CvSize::height)および列数(CvSize::width)を返します.入力が画像の場合は,ROIのサイズが返されます. .. index:: GetSubRect cv::GetSubRect -------------- .. function:: GetSubRect(arr, rect) -> cvmat 入力画像または行列の,矩形部分配列に相当するヘッダを返します. :param arr: 入力配列 :type arr: :class:`CvArr` :param rect: 0 を原点とする座標系で表現される注目矩形領域 :type rect: :class:`CvRect` 関数 ``cvGetSubRect`` は,入力配列中の指定矩形領域に対応するヘッダを返します.つまり,入力配列の一部の矩形領域を独立した配列として扱えるようにします.この関数では ROI を考慮し,実際には ROI の部分配列が取り出されます. .. index:: InRange cv::InRange ----------- .. function:: InRange(src,lower,upper,dst)-> None 入力配列の要素値が,別の2つの配列要素で表される範囲内にあるかどうかをチェックします. :param src: 入力配列 :type src: :class:`CvArr` :param lower: 下界(その値を含む)を表す配列 :type lower: :class:`CvArr` :param upper: 上界(その値は含まない)を表す配列 :type upper: :class:`CvArr` :param dst: 出力配列,8u か 8s 型でなければいけません :type dst: :class:`CvArr` この関数は,入力配列の要素毎に範囲チェックを行います: シングルチャンネル配列の場合, .. math:: \texttt{dst} (I)= \texttt{lower} (I)_0 <= \texttt{src} (I)_0 < \texttt{upper} (I)_0 2チャンネル配列などの場合, .. math:: \texttt{dst} (I)= \texttt{lower} (I)_0 <= \texttt{src} (I)_0 < \texttt{upper} (I)_0 \land \texttt{lower} (I)_1 <= \texttt{src} (I)_1 < \texttt{upper} (I)_1 ``src(I)`` が範囲内にあれば ``dst(I)`` に 0xff(全てのビットが ``1`` )がセットされ,そうでなければ 0 がセットされます.出力配列を除くすべての入力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: InRangeS cv::InRangeS ------------ .. function:: InRangeS(src,lower,upper,dst)-> None 入力配列の要素値が,2つのスカラー値で表される範囲内にあるかどうかをチェックします. :param src: 入力配列 :type src: :class:`CvArr` :param lower: 下界(その値を含む)を表す配列 :type lower: :class:`CvScalar` :param upper: 上界(その値は含まない)を表す配列 :type upper: :class:`CvScalar` :param dst: 出力配列,8u か 8s 型でなければいけません :type dst: :class:`CvArr` この関数は,入力配列の要素毎に範囲チェックを行います: シングルチャンネル配列の場合, .. math:: \texttt{dst} (I)= \texttt{lower} _0 <= \texttt{src} (I)_0 < \texttt{upper} _0 2チャンネル配列などの場合, .. math:: \texttt{dst} (I)= \texttt{lower} _0 <= \texttt{src} (I)_0 < \texttt{upper} _0 \land \texttt{lower} _1 <= \texttt{src} (I)_1 < \texttt{upper} _1 ``src(I)`` が範囲内にあれば ``dst(I)`` に 0xff(全てのビットが ``1`` )がセットされ,そうでなければ 0 がセットされます.出力配列を除く全ての入力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: InvSqrt cv::InvSqrt ----------- .. function:: InvSqrt(value)-> float 平方根の逆数を求めます. :param value: 浮動小数点型の入力値 :type value: float この関数は,引数で与えられた入力値の平方根の逆数を求めます.この関数は,通常, ``1./sqrt(value)`` よりも高速です.入力値が 0以下の場合の処理結果は不定です.また,特別な値( :math:`\pm \infty` , NaN )は扱うことができません. .. index:: Inv cv::Inv ------- :ref:`Invert` .. index:: cv:: ---- .. function:: Invert(src,dst,method=CV_LU)-> double 逆行列,または擬似逆行列を求めます. :param src: 入力行列 :param dst: 出力行列 :param method: 逆行列を求める方法 * **CV_LU** 最適ピボット選択によるガウスの消去法 * **CV_SVD** 特異値分解法(SVD) * **CV_SVD_SYM** 正定値対称行列用の特異値分解法 この関数は, ``src1`` の逆行列を求め,それを ``src2`` に格納します. ``LU`` (ガウスの消去法)を用いた場合,この関数は ``src1`` の行列式を返します(もちろん,src1 は正方でなければならない).この場合の戻り値が 0 の場合,逆行列が計算できなかったという事であり, ``src2`` の要素は 0 で埋められます. ``SVD`` を用いた場合,この関数は ``src1`` の条件数の逆数(最大の特異値に対する最小の特異値の比)を返します. ``src1`` が 0 ならば,この戻り値も 0 になります.また,SVD を用いた場合, ``src1`` が非正則な行列ならば,その擬似逆行列を求めます. .. index:: IsInf cv::IsInf --------- .. function:: IsInf(value)-> int 無限大であるか否かを判定します. :param value: 浮動小数点型の入力値 :type value: float この関数は,引数で与えられた入力値が :math:`\pm \infty` (無限大;IEEE754 で定義されている)の場合は 1 を返し,そうでなければ 0 を返します. .. index:: IsNaN cv::IsNaN --------- .. function:: IsNaN(value)-> int NaN であるか否かを判定します. :param value: 浮動小数点型の入力値 :type value: float この関数は,引数で与えられた入力値が NaN(非数値;IEEE754 で定義されている)の場合は 1 を返し,そうでなければ 0 を返します. .. index:: LUT cv::LUT ------- .. function:: LUT(src,dst,lut)-> None ルックアップテーブルを用いて配列を変換します. :param src: 各要素が8ビットの入力配列 :type src: :class:`CvArr` :param dst: 任意のビット深度,入力配列と等しいチャンネル数の出力配列 :type dst: :class:`CvArr` :param lut: 出力配列と等しいビット深度の256要素で構成されるルックアップテーブル.入出力配列がマルチチャンネルの場合,ルックアップテーブルは,シングルチャンネル(この場合は,各チャンネルに対して同じテーブルを使います),あるいは入出力配列と同じチャンネル数である必要があります :type lut: :class:`CvArr` この関数は,ルックアップテーブルから取り出した値で出力配列を埋めます.テーブルの要素を指定するインデックスには,入力配列の値が用いられます.つまり,この関数は ``src`` の各要素を以下のように処理します: .. math:: \texttt{dst} _i \leftarrow \texttt{lut} _{ \texttt{src} _i + d} ここで, .. math:: d = \fork{0}{if \texttt{src} has depth \texttt{CV\_8U}}{128}{if \texttt{src} has depth \texttt{CV\_8S}} です. .. index:: Log cv::Log ------- .. function:: Log(src,dst)-> None 各配列要素の絶対値の自然対数を求めます. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列, ``double`` 型,あるいは入力配列と同じ型 :type dst: :class:`CvArr` この関数は,入力配列の各要素に対して自然対数を求めます: .. math:: \texttt{dst} [I] = \fork{\log{|\texttt{src}(I)}}{if $\texttt{src}[I] \ne 0$ }{\texttt{C}}{otherwise} ここで ``C`` は,大きな負の値です(現在の実装では,およそ -700). .. index:: Mahalonobis cv::Mahalonobis --------------- .. function:: Mahalonobis(vec1,vec2,mat)-> None 2つのベクトル間のマハラノビス距離を求めます. :param vec1: 1番目の1次元入力ベクトル :type vec1: :class:`CvArr` :param vec2: 2番目の1次元入力ベクトル :type vec2: :class:`CvArr` :param mat: 分散共分散行列の逆行列 :type mat: :class:`CvArr` この関数は,2つのベクトル間の重み付き距離を計算して返します: .. math:: d( \texttt{vec1} , \texttt{vec2} )= \sqrt{\sum_{i,j}{\texttt{icovar(i,j)}\cdot(\texttt{vec1}(I)-\texttt{vec2}(I))\cdot(\texttt{vec1(j)}-\texttt{vec2(j)})} } 共分散行列は,関数 :ref:`CalcCovarMatrix` によって求められ,その逆行列は,関数 :ref:`Invert` (行列は非正則であるかもしれないので CV _ SVD フラグの指定が望ましい)によって求められます. .. index:: Max cv::Max ------- .. function:: Max(src1,src2,dst)-> None 2つの配列の要素同士で大きい方を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,2つの配列の各要素を比較して大きい方を求めます: .. math:: \texttt{dst} (I)= \max ( \texttt{src1} (I), \texttt{src2} (I)) すべての入力配列は シングルチャンネルで,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: MaxS cv::MaxS -------- .. function:: MaxS(src,value,dst)-> None 配列の各要素とスカラー値を比較して大きい方を求めます. :param src: 入力配列 :type src: :class:`CvArr` :param value: スカラー値 :type value: float :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,配列の各要素とスカラー値を比較して大きい方を求めます: .. math:: \texttt{dst} (I)= \max ( \texttt{src} (I), \texttt{value} ) すべての入力配列は シングルチャンネルで,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: Merge cv::Merge --------- .. function:: Merge(src0,src1,src2,src3,dst)-> None 複数のシングルチャンネル配列を用いて1つのマルチチャンネル配列を構成します.または,配列に1つのチャンネルを挿入します. :param src0: 入力チャンネル 0 :type src0: :class:`CvArr` :param src1: 入力チャンネル 1 :type src1: :class:`CvArr` :param src2: 入力チャンネル 2 :type src2: :class:`CvArr` :param src3: 入力チャンネル 3 :type src3: :class:`CvArr` :param dst: 最終的に作成される出力配列 :type dst: :class:`CvArr` 関数 ``cvMerge`` は, :ref:`Split` とは逆の操作を行います.出力配列が N チャンネルを持ち,引数の最初の N 個のチャンネルが NULL ではない場合,全てのチャンネルがコピーされます.引数の最初の N 個のチャンネルのうち1つだけが NULL ではない場合,そのチャンネルだけが出力配列にコピーされます.そのどちらでもない場合([NULL,NULL,NULL,NULL],[NULL,notNULL,notNULL,NULL]など),エラーとなります.残りの(N 番目以降の)入力チャンネルは,常に NULL でなければいけません.COI を設定した IplImage 画像に1つのチャンネルを挿入するためには, :ref:`Copy` を利用することもできます. .. index:: Min cv::Min ------- .. function:: Min(src1,src2,dst)-> None 2つの配列の要素同士で小さい方を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,2つの配列の各要素を比較して小さい方を求めます: .. math:: \texttt{dst} (I)= \min ( \texttt{src1} (I), \texttt{src2} (I)) すべての入力配列は シングルチャンネルで,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: MinMaxLoc cv::MinMaxLoc ------------- .. function:: MinMaxLoc(arr,mask=NULL)-> (minVal,maxVal,minLoc,maxLoc) 配列(部分配列)の要素の最大値と最小値を求めます. :param arr: シングルチャンネルの配列,あるいは COI が設定されたマルチチャンネル画像 :type arr: :class:`CvArr` :param minVal: 最小値が出力される変数へのポインタ :type minVal: float :param maxVal: 最大値が出力される変数へのポインタ :type maxVal: float :param minLoc: 最小値の位置が出力される変数へのポインタ :type minLoc: :class:`CvPoint` :param maxLoc: 最大値の位置が出力される変数へのポインタ :type maxLoc: :class:`CvPoint` :param mask: 部分配列を選択するためのオプションマスク :type mask: :class:`CvArr` この関数は,配列の要素の最大・最小値とその位置を求めます.それぞれの値を求めるためにスキャンされる領域は,画像全体あるいはセットされた ``ROI`` ( ``IplImage`` の場合), また ``mask`` が ``NULL`` ではない場合は,指定された部分配列領域です.もし,入力がマルチチャンネル配列ならば,それは ``COI`` が設定された ``IplImage`` 型でなければいけません. 入力が2次元配列の場合,極値の座標が ``min_loc->x`` と ``max_loc->x`` に格納されます. .. index:: MinS cv::MinS -------- .. function:: MinS(src,value,dst)-> None 配列の各要素とスカラー値を比較して小さい方を求めます. :param src: 1番目の入力配列 :type src: :class:`CvArr` :param value: スカラー値 :type value: float :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,配列の各要素とスカラー値を比較して大きい方を求めます: .. math:: \texttt{dst} (I)= \min ( \texttt{src} (I), \texttt{value} ) すべての入力配列は シングルチャンネルで,同じデータ型,同じサイズ(または ROI サイズ)でなければいけません. Mirror ------ :ref:`Flip` と同義です. .. index:: MixChannels cv::MixChannels --------------- .. function:: MixChannels(src, dst, fromTo) -> None 入力配列から出力配列へ,指定された(複数の)チャンネルをコピーします. :param src: 入力配列(の配列) :type src: :class:`cvarr_count` :param dst: 出力配列(の配列) :type dst: :class:`cvarr_count` :param from_to: コピーされる平面を示すインデックスのペア(入出力)の配列. それぞれの組み合わせ ``from_to[k]=(i,j)`` は, ``src`` の i番目の平面が ``dst`` の j番目の平面にコピーされることを意味します. また,入力配列リストおよび出力配列リストでは,連続した平面番号が用いられます.特別なケースととして, ``from_to[k][0]`` が負の値の場合,対応する出力平面 ``j`` が0で埋められます この関数は, :ref:`Split` , :ref:`Merge` および :ref:`CvtColor` のある形式を一般化したものです. 色平面の順番の変更,アルファチャンネルの追加や削除,1つあるいは複数の色平面の挿入や抽出,などに用いることができます. 例として,4チャンネル RGBA 画像を,3チャンネル BGR 画像(つまり,R と B の交換)とアルファチャンネル画像の2つに分離するコードを示します: :: rgba = cv.CreateMat(100, 100, cv.CV_8UC4) bgr = cv.CreateMat(100, 100, cv.CV_8UC3) alpha = cv.CreateMat(100, 100, cv.CV_8UC1) cv.Set(rgba, (1,2,3,4)) cv.MixChannels([rgba], [bgr, alpha], [ (0, 2), # rgba[0] -> bgr[2] (1, 1), # rgba[1] -> bgr[1] (2, 0), # rgba[2] -> bgr[0] (3, 3) # rgba[3] -> alpha[0] ]) .. MulAddS ------- :ref:`ScaleAdd` と同義です. .. index:: Mul cv::Mul ------- .. function:: Mul(src1,src2,dst,scale)-> None 2つの配列の要素毎の積を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param scale: オプションであるスケール係数 :type scale: float この関数は,2つの配列要素ごとの積を計算します: .. math:: \texttt{dst} (I)= \texttt{scale} \cdot \texttt{src1} (I) \cdot \texttt{src2} (I) すべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: MulSpectrums cv::MulSpectrums ---------------- .. function:: MulSpectrums(src1,src2,dst,flags)-> None 2つのフーリエ・スペクトルの,要素毎の積を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 入力配列と同じサイズ,同じ型である出力配列 :type dst: :class:`CvArr` :param flags: 以下の値の組み合わせ: * **CV_DXT_ROWS** 配列の各行を個別のスペクトルとして扱います( :ref:`DFT` のパラメータ説明を参照してください) * **CV_DXT_MUL_CONJ** 積を計算する前に,2 番目の入力配列の共役を求めます :type flags: int この関数は,2つの CCS-packed 形式の配列 または 複素行列において,その要素毎の掛け算を行います. この2つの行列は,実数あるいは複素数のフーリエ変換の結果です. この関数と関数 :ref:`DFT` を利用することで,2つの配列の畳み込みを高速に計算することができます. .. index:: MulTransposed cv::MulTransposed ----------------- .. function:: MulTransposed(src,dst,order,delta=NULL,scale)-> None 行列とその行列の転置行列の積を求めます. :param src: 入力行列 :type src: :class:`CvArr` :param dst: 出力行列. ``CV_32F`` あるいは ``CV_64F`` でなければいけません :type dst: :class:`CvArr` :param order: 転置した行列をかける順番 :type order: int :param delta: オプション.乗算の前に行列 ``src`` から差し引かれる行列 :type delta: :class:`CvArr` :param scale: オプション.スケール係数 :type scale: float この関数は,src とその転置行列の積を求めます: この関数は,以下のように計算を行います.もし :math:`\texttt{order}=0` の場合は, .. math:: \texttt{dst} = \texttt{scale} ( \texttt{src} - \texttt{delta} ) ( \texttt{src} - \texttt{delta} )^T そうでない場合は, .. math:: \texttt{dst} = \texttt{scale} ( \texttt{src} - \texttt{delta} )^T ( \texttt{src} - \texttt{delta} ) .. index:: Norm cv::Norm -------- .. function:: Norm(arr1,arr2,normType=CV_L2,mask=NULL)-> double 配列の絶対値ノルム,絶対値差分ノルム,相対値差分ノルムを求めます. :param arr1: 1 番目の入力画像 :type arr1: :class:`CvArr` :param arr2: 2 番目の入力画像.NULLの場合は ``arr1`` の絶対値ノルムが求められ,そうでなければ ``arr1`` - ``arr2`` の絶対値ノルムあるいは相対値ノルムが求められます :type arr2: :class:`CvArr` :param normType: ノルムの種類,以下の説明を参照してください :type normType: int :param mask: オプションである処理マスク :type mask: :class:`CvArr` この関数は, ``arr2`` が NULL の場合は ``arr1`` の絶対値ノルムを計算します: .. math:: norm = \forkthree{||\texttt{arr1}||_C = \max_I |\texttt{arr1}(I)|}{if $\texttt{normType} = \texttt{CV\_C}$}{||\texttt{arr1}||_{L1} = \sum_I |\texttt{arr1}(I)|}{if $\texttt{normType} = \texttt{CV\_L1}$}{||\texttt{arr1}||_{L2} = \sqrt{\sum_I \texttt{arr1}(I)^2}}{if $\texttt{normType} = \texttt{CV\_L2}$} ``arr2`` が NULL でない場合は,絶対値差分ノルムが計算されます: .. math:: norm = \forkthree{||\texttt{arr1}-\texttt{arr2}||_C = \max_I |\texttt{arr1}(I) - \texttt{arr2}(I)|}{if $\texttt{normType} = \texttt{CV\_C}$}{||\texttt{arr1}-\texttt{arr2}||_{L1} = \sum_I |\texttt{arr1}(I) - \texttt{arr2}(I)|}{if $\texttt{normType} = \texttt{CV\_L1}$}{||\texttt{arr1}-\texttt{arr2}||_{L2} = \sqrt{\sum_I (\texttt{arr1}(I) - \texttt{arr2}(I))^2}}{if $\texttt{normType} = \texttt{CV\_L2}$} または, ``arr2`` が NULL でなく,かつ ``(normType & CV_RELATIVE) != 0`` である場合は相対値差分ノルムが計算されます: .. math:: norm = \forkthree{\frac{||\texttt{arr1}-\texttt{arr2}||_C }{||\texttt{arr2}||_C }}{if $\texttt{normType} = \texttt{CV\_RELATIVE\_C}$}{\frac{||\texttt{arr1}-\texttt{arr2}||_{L1} }{||\texttt{arr2}||_{L1}}}{if $\texttt{normType} = \texttt{CV\_RELATIVE\_L1}$}{\frac{||\texttt{arr1}-\texttt{arr2}||_{L2} }{||\texttt{arr2}||_{L2}}}{if $\texttt{normType} = \texttt{CV\_RELATIVE\_L2}$} この関数は,求めたノルムを返します.マルチチャンネル配列は,シングルチャンネル配列として扱われます.つまり,全てのチャンネルに対する処理結果が合計されます. .. index:: Not cv::Not ------- .. function:: Not(src,dst)-> None 配列の各要素をビット単位で反転します. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,配列の各要素の各ビットを反転します: :: dst(I)=~src(I) .. .. index:: Or cv::Or ------ .. function:: Or(src1,src2,dst,mask=NULL)-> None 2つの配列の要素毎に,ビット単位の論理和を計算します. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,2つの配列の要素毎にビット単位の論理和を計算します: :: dst(I)=src1(I)|src2(I) .. 浮動小数点型配列の場合は,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ種類,同じサイズ(または ROI サイズ)でなければいけません. .. index:: OrS cv::OrS ------- .. function:: OrS(src,value,dst,mask=NULL)-> None スカラー値と配列の要素毎に,ビット単位の論理和を計算します. :param src: 入力配列 :type src: :class:`CvArr` :param value: スカラー値 :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー値と配列要素ごとに,ビット単位の論理和を計算します: :: dst(I)=src(I)|value if mask(I)!=0 .. 実際の計算の前に,スカラー値は配列と同じ型に変換されます.また,浮動小数点型配列の場合は,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ種類,同じサイズ(または ROI サイズ)でなければいけません. .. index:: PerspectiveTransform cv::PerspectiveTransform ------------------------ .. function:: PerspectiveTransform(src,dst,mat)-> None ベクトルの透視投影変換を行います. :param src: 3チャンネル,浮動小数点型の入力配列 :type src: :class:`CvArr` :param dst: 3チャンネル,浮動小数点型の出力配列 :type dst: :class:`CvArr` :param mat: :math:`3\times 3` あるいは :math:`4 \times 4` の変換行列 :type mat: :class:`CvMat` この関数は,配列 ``src`` の各要素(2次元,あるいは3次元のベクトルとして扱われます)を以下のように変換します: .. math:: (x, y, z) \rightarrow (x'/w, y'/w, z'/w) ここで, .. math:: (x', y', z', w') = \texttt{mat} \cdot \begin{bmatrix} x & y & z & 1 \end{bmatrix} また, .. math:: w = \fork{w'}{if $w' \ne 0$}{\infty}{otherwise} となります. .. index:: PolarToCart cv::PolarToCart --------------- .. function:: PolarToCart(magnitude,angle,x,y,angleInDegrees=0)-> None 極座標系で表現された2次元ベクトルを,カーテシアン座標系表現に変換します. :param magnitude: 各2次元ベクトル大きさを表す配列.NULL ならば,すべてのベクトルの大きさが 1 と見なされます :type magnitude: :class:`CvArr` :param angle: 各2次元ベクトルの角度を表す配列.単位は,ラジアンあるいは度です :type angle: :class:`CvArr` :param x: 変換後の x 座標を表す出力配列.結果が必要なければ,NULLでも構いません :type x: :class:`CvArr` :param y: 変換後の y 座標を表す出力配列.結果が必要なければ,NULLでも構いません :type y: :class:`CvArr` :param angleInDegrees: 出力である角度をデフォルトの「ラジアン」で表現するか,あるいは「度」で表現するかを指定するフラグ :type angleInDegrees: int この関数は,各ベクトル ``magnitude(I)*exp(angle(I)*j), j=sqrt(-1)`` の x-座標,y-座標 を求めます: :: x(I)=magnitude(I)*cos(angle(I)), y(I)=magnitude(I)*sin(angle(I)) .. .. index:: Pow cv::Pow ------- .. function:: Pow(src,dst,power)-> None 各配列要素をそれぞれ指定された値で累乗します. :param src: 入力配列 :type src: :class:`CvArr` :param dst: 出力配列,入力と同じ型である必要があります :type dst: :class:`CvArr` :param power: 累乗の指数 :type power: float この関数は,入力配列の各要素を ``power`` 乗します: .. math:: \texttt{dst} [I] = \fork{\texttt{src}(I)^p}{if \texttt{p} is integer}{|\texttt{src}(I)^p|}{otherwise} つまり,指数 ``power`` が整数ではない場合は,入力配列要素の絶対値が計算に用いられます.しかし,入力要素が負の場合でも,いくつか処理を追加すると正しい結果を得ることができます.以下に,配列要素それぞれの立方根を求めるサンプルを示します: .. doctest:: >>> import cv >>> src = cv.CreateMat(1, 10, cv.CV_32FC1) >>> mask = cv.CreateMat(src.rows, src.cols, cv.CV_8UC1) >>> dst = cv.CreateMat(src.rows, src.cols, cv.CV_32FC1) >>> cv.CmpS(src, 0, mask, cv.CV_CMP_LT) # 負の要素を見つけます. >>> cv.Pow(src, dst, 1. / 3) >>> cv.SubRS(dst, cv.ScalarAll(0), dst, mask) # 負の入力値に対する結果の正負を反転します. .. ``power`` が整数値や 0.5,-0.5 などの特別な値の場合は,より高速なアルゴリズムが用いられます. .. index:: RNG cv::RNG ------- .. function:: RNG(seed=-1LL)-> CvRNG 乱数生成器を初期化します. :param seed: 乱数列を初期化するための64ビットの数値 :type seed: :class:`int64` この関数は乱数生成器を初期化し,その状態を表す構造体を返します.その状態構造体へのポインタが,関数 :ref:`RandInt` , :ref:`RandReal` , :ref:`RandArr` に渡されます.現在の実装では,繰り上げ付き乗算アルゴリズム(multiply-with-carry)が利用されています. .. index:: RandArr cv::RandArr ----------- .. function:: RandArr(rng,arr,distType,param1,param2)-> None 配列を乱数で埋め,RNG の状態を更新します. :param rng: :ref:`RNG` によって初期化された RNG 状態構造体へのポインタ :type rng: :class:`CvRNG` :param arr: 出力配列 :type arr: :class:`CvArr` :param distType: 乱数分布の種類 * **CV_RAND_UNI** 一様分布 * **CV_RAND_NORMAL** 正規分布(ガウス分布) :type distType: int :param param1: 1番目の分布パラメータ.一様分布の場合,発生する乱数の下界(この値を含みます)を表します.正規分布の場合,分布の平均値を表します :type param1: :class:`CvScalar` :param param2: 2番目の分布パラメータ.一様分布の場合,発生する乱数の上界(この値を含みません)を表します.正規分布の場合,分布の標準偏差を表します :type param2: :class:`CvScalar` この関数は,一様分布した乱数,あるいは正規分布した乱数を用いて出力配列を埋めます. .. index:: RandInt cv::RandInt ----------- .. function:: RandInt(rng)-> unsigned 32ビット符号なし整数型の乱数を返し,RNG の状態を更新します. :param rng: ``RandInit`` によって初期化され,オプションで ``RandSetRange`` によってカスタマイズされるRNG状態構造体へのポインタ(後者の関数は,この関数の結果に影響しません) :type rng: :class:`CvRNG` この関数は,一様分布に従う 32 ビット符号なし整数型の乱数を返し,RNG の状態を更新します.これは,C言語のランタイムライブラリの rand() 関数に類似しています.しかし,rand() が 0 から ``RAND_MAX`` ( :math:`2^{16}` または :math:`2^{32}` ,プラットホームに依存)までの値を返すの対して,この関数では常に32ビットの値を生成します. この関数は,点座標,領域サイズ,テーブルインデックスなどの乱数値を生成するのに用いることができます.特定範囲内の整数は剰余演算によって生成でき,特定範囲内の浮動小数点数は,値の範囲を 0...1 にスケーリングするように割算することで生成できます. .. index:: RandReal cv::RandReal ------------ .. function:: RandReal(rng)-> double 浮動小数点型の乱数を返し,RNG の状態を更新します. :param rng: :ref:`RNG` によって初期化された RNG 状態構造体へのポインタ :type rng: :class:`CvRNG` この関数は,0 から 1 の範囲(1自身は含まれない)の一様分布に従う浮動小数点型の乱数を返します. .. index:: Reduce cv::Reduce ---------- .. function:: Reduce(src,dst,dim=-1,op=CV_REDUCE_SUM)-> None 行列をベクトルに変換します. :param src: 入力行列 :type src: :class:`CvArr` :param dst: 入力行列の全ての行または列を指定された方法で累積する,1行または1列の出力ベクトル :type dst: :class:`CvArr` :param dim: 配列の縮小方法を示す次元インデックス.0 の場合は,行列を 1行ベクトルに変換する.1 の場合は,行列を 1 列ベクトルに変換します.-1の場合は, ``dst`` サイズを解析して自動的に次元を選択します :type dim: int :param op: 変換処理.以下の値をとる: * **CV_REDUCE_SUM** 出力ベクトルは,各行(あるいは各列)の総和 * **CV_REDUCE_AVG** 出力ベクトルは,各行(あるいは各列)の平均 * **CV_REDUCE_MAX** 出力ベクトルは,各行(あるいは各列)の最大値 * **CV_REDUCE_MIN** 出力ベクトルは,各行(あるいは各列)の最小値 :type op: int この関数は,入力行列の各行(あるいは各列)を 1 次元ベクトルの集合として扱い,その集合に対して指定された処理を行うことで行列をベクトルに変換します.例えば,ラスタ画像の水平,垂直方向への射影を計算することができます. ``CV_REDUCE_SUM`` や ``CV_REDUCE_AVG`` の場合は,計算精度を保つために(桁溢れしないように)出力ベクトル要素のビット深度を入力よりも大きくとるべきです.また,これらの2つのモードの場合は,マルチチャンネル画像を扱うこともできます. .. index:: Repeat cv::Repeat ---------- .. function:: Repeat(src,dst)-> None コピー元配列を用いて,コピー先配列をタイル状に埋めます. :param src: コピー元配列,画像または行列 :type src: :class:`CvArr` :param dst: コピー先配列,画像または行列 :type dst: :class:`CvArr` この関数は,コピー元配列を繰り返しコピーして,コピー先配列を埋めます: :: dst(i,j)=src(i mod rows(src), j mod cols(src)) .. コピー先配列は,コピー元配配列より大きくても小さくても構いません. .. index:: ResetImageROI cv::ResetImageROI ----------------- .. function:: ResetImageROI(image)-> None 画像全体が操作対象となるように ROI をリセットして,ROI 構造体を解放します. :param image: 画像ヘッダへのポインタ :type image: :class:`IplImage` これは,以下の操作に似ています. :: cv.SetImageROI(image, (0, 0, image.width, image.height)) cv.SetImageCOI(image, 0) .. .. index:: Reshape cv::Reshape ----------- .. function:: Reshape(arr, newCn, newRows=0) -> cvmat データをコピーせずに行列/画像の形状を変更します. :param arr: 入力配列 :param newCn: 新しいチャンネル数. 'new _ cn = 0' の場合は,チャンネル数は変更されません :param newRows: 新しい行数. 'new _ rows = 0' の場合は, ``newCn`` の値によって変更の必要がでてくる場合を除いて,行数は変更されない この関数は,与えられた配列を元に CvMat ヘッダを初期化します.これは,元の配列とは異なる形状(チャンネル数や行数が異なる)で,元の配列と同じデータへのポインタを持つ新しい配列ヘッダとなります. .. index:: ReshapeMatND cv::ReshapeMatND ---------------- .. function:: ReshapeMatND(arr, newCn, newDims) -> cvmat データをコピーせずに多次元配列の形状を変更します. :param arr: 入力配列 :param newCn: 新しいチャンネル数. :math:`\texttt{newCn} = 0` の場合は,チャンネル数が変更されていないことを示します :param newDims: 新しい次元を表すリスト この関数は, :ref:`Reshape` の拡張バージョンです.この関数は,多次元配列を扱うことができ(普通の画像と行列も扱えます),次元数を変更する事も可能です. ``arr`` として同じデータを共有するものの,異なる次元または異なるチャンネル数の,新しい :ref:`CvMatND` を返します.唯一の要件は,データの総長が変化しないことです. .. doctest:: >>> import cv >>> mat = cv.CreateMatND([24], cv.CV_32FC1) >>> print cv.GetDims(cv.ReshapeMatND(mat, 0, [8, 3])) (8, 3) >>> m2 = cv.ReshapeMatND(mat, 4, [3, 2]) >>> print cv.GetDims(m2) (3, 2) >>> print m2.channels 4 .. .. index:: Round cv::Round --------- .. function:: Round(value) -> int 浮動小数点数を,最も近い整数値に変換します. :param value: 入力される浮動小数点値 :type value: float アーキテクチャによっては,この関数は,標準のキャスト操作よりもかなり速い場合があります.引数の絶対値が :math:`2^{31}` よりも大きい場合の結果は不定です.また,特別な値( :math:`\pm \infty` , NaN )は扱うことができません. .. index:: Floor cv::Floor --------- .. function:: Floor(value) -> int 浮動小数点数を,その値以下の最も近い整数値に変換します. :param value: 入力される浮動小数点値 :type value: float アーキテクチャによっては,この関数は,標準のキャスト操作よりもかなり速い場合があります.引数の絶対値が :math:`2^{31}` よりも大きい場合の結果は不定です.また,特別な値( :math:`\pm \infty` , NaN )は扱うことができません. .. index:: Ceil cv::Ceil -------- .. function:: Ceil(value) -> int 浮動小数点数を,その値以上の最も近い整数値に変換します. :param value: 入力される浮動小数点値 :type value: float アーキテクチャによっては,この関数は,標準のキャスト操作よりもかなり速い場合があります.引数の絶対値が :math:`2^{31}` よりも大きい場合の結果は不定です.また,特別な値( :math:`\pm \infty` , NaN )は扱うことができません. .. index:: ScaleAdd cv::ScaleAdd ------------ .. function:: ScaleAdd(src1,scale,src2,dst)-> None スケーリングされた配列ともう1つの配列の和を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param scale: 1 番目の入力配列を定数倍するスケール係数 :type scale: :class:`CvScalar` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` この関数は,スケーリングされた配列ともう1つの配列の和を求めます: .. math:: \texttt{dst} (I)= \texttt{scale} \, \texttt{src1} (I) + \texttt{src2} (I) すべての入出力配列は,同じ型,同じサイズでなければいけません. .. index:: Set cv::Set ------- .. function:: Set(arr,value,mask=NULL)-> None 配列の各要素に与えられた値をセットします. :param arr: 値をセットする配列 :type arr: :class:`CvArr` :param value: セットされる値 :type value: :class:`CvScalar` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー値 ``value`` を,配列の指定された要素すべてにコピーします: .. math:: \texttt{arr} (I)= \texttt{value} \quad \text{if} \quad \texttt{mask} (I) \ne 0 配列 ``arr`` が, ``IplImage`` 型である場合,ROI は利用されますが COI を設定してはいけません. .. index:: Set1D cv::Set1D --------- .. function:: Set1D(arr, idx, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx: 要素インデックス.0が基準点 :type idx: int :param value: 要素に割り当てられる値 :type value: :class:`CvScalar` 特定の配列要素をセットします.この配列は,1次元でなければいけません. .. index:: Set2D cv::Set2D --------- .. function:: Set2D(arr, idx0, idx1, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素の行インデックス.0が基準点 :type idx0: int :param idx1: 要素の列インデックス.0が基準点 :type idx1: int :param value: 要素に割り当てられる値 :type value: :class:`CvScalar` 特定の配列要素をセットします.この配列は,2次元でなければいけません. .. index:: Set3D cv::Set3D --------- .. function:: Set3D(arr, idx0, idx1, idx2, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素のインデックス.0が基準点 :type idx0: int :param idx1: 要素のインデックス.0が基準点 :type idx1: int :param idx2: 要素のインデックス.0が基準点 :type idx2: int :param value: 要素に割り当てられる値 :type value: :class:`CvScalar` 特定の配列要素をセットします.この配列は,3次元でなければいけません. .. index:: SetND cv::SetND --------- .. function:: SetND(arr, indices, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param indices: 要素インデックスのリスト.0が基準点 :type indices: sequence of int :param value: 要素に割り当てられる値 :type value: :class:`CvScalar` 特定の配列要素をセットします.インデックスリストの長さは,この配列の次元と一致していなければいけません. .. index:: SetData cv::SetData ----------- .. function:: SetData(arr, data, step)-> None ユーザデータを配列のヘッダに割り当てます. :param arr: 配列のヘッダ :param data: ユーザデータ :param step: バイト単位で表される行の長さ この関数は,ユーザデータを配列のヘッダに割り当てます.このヘッダは,関数 ``cvCreate*Header`` , ``cvInit*Header`` あるいは :ref:`Mat` (行列の場合)を用いて,あらかじめ初期化しておく必要があります. .. index:: SetIdentity cv::SetIdentity --------------- .. function:: SetIdentity(mat,value=1)-> None 行列をスカラー倍された単位行列として初期化します. :param mat: 初期化される行列(正方である必要はありません) :type mat: :class:`CvArr` :param value: 対角要素に割り当てられる値 :type value: :class:`CvScalar` この関数は,行列をスカラー倍された単位行列として初期化します: .. math:: \texttt{arr} (i,j)= \fork{\texttt{value}}{ if $i=j$}{0}{otherwise} .. index:: SetImageCOI cv::SetImageCOI --------------- .. function:: SetImageCOI(image, coi)-> None IplImage に COI を設定します. :param image: 画像ヘッダへのポインタ :type image: :class:`IplImage` :param coi: 注目チャンネル.0 - 全てのチャンネルを選択,1 - 1番目のチャンネルを選択,2以下も同様.チャンネルは,1から始まることに注意してください :type coi: int ROI が ``NULL`` に設定されており,COI が 0 *ではない* 場合,COIが確保されます. ほとんどの OpenCV の関数は,COI をサポート *しません* .よって,画像や行列のそれぞれのチャンネルを処理する場合, チャンネルを( :ref:`Copy` や :ref:`Split` によって)別々の画像や行列にコピーしてから処理を行い, 必要ならばその結果を( :ref:`Copy` や :ref:`Merge` によって)再びコピーして戻します. .. index:: SetImageROI cv::SetImageROI --------------- .. function:: SetImageROI(image, rect)-> None 与えられた矩形領域を,画像の ROI として設定します. :param image: 画像ヘッダへのポインタ :type image: :class:`IplImage` :param rect: ROI を表す矩形領域 :type rect: :class:`CvRect` 元の画像の ROI が ``NULL`` であり ``rect`` が画像全体ではない場合,ROI 構造体が確保されます. ほとんどの OpenCV の関数が ROI をサポートしており,矩形の部分画像を別の画像として扱うことができます.例えば,全てのピクセル座標は,元画像の原点からではなく,ROI の原点(左上あるいは左下)からカウントされます. .. index:: SetReal1D cv::SetReal1D ------------- .. function:: SetReal1D(arr, idx, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx: 要素インデックス.0が基準点 :type idx: int :param value: 要素に割り当てられる値 :type value: float 特定の配列要素をセットします.この配列は,1次元でなければいけません. .. index:: SetReal2D cv::SetReal2D ------------- .. function:: SetReal2D(arr, idx0, idx1, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素の行インデックス.0が基準点 :type idx0: int :param idx1: 要素の列インデックス.0が基準点 :type idx1: int :param value: 要素に割り当てられる値 :type value: float 特定の配列要素をセットします.この配列は,2次元でなければいけません. .. index:: SetReal3D cv::SetReal3D ------------- .. function:: SetReal3D(arr, idx0, idx1, idx2, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param idx0: 要素インデックス.0が基準点 :type idx0: int :param idx1: 要素インデックス.0が基準点 :type idx1: int :param idx2: 要素インデックス.0が基準点 :type idx2: int :param value: 要素に割り当てられる値 :type value: float 特定の配列要素をセットします.この配列は,3次元でなければいけません. .. index:: SetRealND cv::SetRealND ------------- .. function:: SetRealND(arr, indices, value) -> None 特定の配列要素をセットします. :param arr: 入力配列 :type arr: :class:`CvArr` :param indices: 要素インデックスのリスト.0が基準点 :type indices: sequence of int :param value: 要素に割り当てられる値 :type value: float 特定の配列要素をセットします.インデックスリストの長さは,この配列の次元と一致していなければいけません. .. index:: SetZero cv::SetZero ----------- .. function:: SetZero(arr)-> None 配列をクリアします. :param arr: クリアされる配列 :type arr: :class:`CvArr` この関数は,配列をクリアします.密な配列(CvMat,CvMatND,IplImage)に対する cvZero(array) は,cvSet(array,cvScalarAll(0),0) と等価です. 疎な配列の場合は,全ての要素が削除されます. .. index:: Solve cv::Solve --------- .. function:: Solve(A,B,X,method=CV_LU)-> None 連立1次方程式,あるいは最小2乗問題を解きます. :param A: 入力行列 :type A: :class:`CvArr` :param B: 連立一次方程式の右辺 :type B: :class:`CvArr` :param X: 出力解 :type X: :class:`CvArr` :param method: 逆行列を求める方法 * **CV_LU** 最適ピボット選択によるガウスの消去法 * **CV_SVD** 特異値分解法(SVD) * **CV_SVD_SYM** 正定値対称行列用の特異値分解法 :type method: int この関数は,連立1次方程式あるいは最小2乗問題を解きます(後者は,SVD によって求められます): .. math:: \texttt{dst} = argmin_X|| \texttt{src1} \, \texttt{X} - \texttt{src2} || ``CV_LU`` の手法が用いられる場合, ``src1`` が正則行列であれば 1 を返し,そうでなければ 0 を返します. 後者の場合, ``dst`` の値は有効なものではありません. .. index:: SolveCubic cv::SolveCubic -------------- .. function:: SolveCubic(coeffs,roots)-> None 3次方程式の実根を求めます. :param coeffs: 3個あるいは4個の値をもつ,方程式の係数配列 :type coeffs: :class:`CvMat` :param roots: 実根の出力配列.3個の要素をもちます :type roots: :class:`CvMat` この関数は,3次方程式の実根を求めます: coeffs が4要素のベクトルである場合: .. math:: \texttt{coeffs} [0] x^3 + \texttt{coeffs} [1] x^2 + \texttt{coeffs} [2] x + \texttt{coeffs} [3] = 0 coeffs が3要素のベクトルである場合: .. math:: x^3 + \texttt{coeffs} [0] x^2 + \texttt{coeffs} [1] x + \texttt{coeffs} [2] = 0 この関数は,求めた実根の個数を返し,その実根は ``root`` 配列に格納されます..実根が1つだけの場合,配列の残りの要素は 0 で埋められます. .. index:: Split cv::Split --------- .. function:: Split(src,dst0,dst1,dst2,dst3)-> None マルチチャンネル配列を複数のシングルチャンネル配列に分割します.または,配列から1つのチャンネルだけを抜き出します. :param src: 入力配列 :type src: :class:`CvArr` :param dst0: 出力チャンネル 0 :type dst0: :class:`CvArr` :param dst1: 出力チャンネル 1 :type dst1: :class:`CvArr` :param dst2: 出力チャンネル 2 :type dst2: :class:`CvArr` :param dst3: 出力チャンネル 3 :type dst3: :class:`CvArr` この関数は,マルチチャンネル配列を複数のシングルチャンネル配列に分割します.この操作には2つのモードが存在します. 入力配列が N チャンネルで,引数の最初の N 個のチャンネルが NULL ではない場合,全てのチャンネルが抜き出されます. 引数の最初の N 個のチャンネルのうち1つだけが NULL ではない場合,そのチャンネルだけが抜き出されます. そのどちらでもない場合([NULL,NULL,NULL,NULL],[NULL,notNULL,notNULL,NULL]など),エラーとなります. 残りの出力チャンネル(最初のN個より後ろ)は,常にNULLでなければいけません. COI を設定した IplImage 画像から1つのチャンネルを抜き出すためには, :ref:`Copy` を利用することもできます. .. index:: Sqrt cv::Sqrt -------- .. function:: Sqrt(value)-> float 平方根を求めます. :param value: 浮動小数点型の入力値 :type value: float この関数は,引数で与えられた入力値の平方根を求めます.入力値が負の場合は,処理結果は不定です. .. index:: Sub cv::Sub ------- .. function:: Sub(src1,src2,dst,mask=NULL)-> None 2つの配列の要素毎の差を求めます. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,1つの配列からもう1つの配列を引きます: :: dst(I)=src1(I)-src2(I) if mask(I)!=0 .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: SubRS cv::SubRS --------- .. function:: SubRS(src,value,dst,mask=NULL)-> None スカラー値から配列要素を引きます. :param src: 入力配列 :type src: :class:`CvArr` :param value: 引き算されるスカラー :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー値から入力配列の各要素を引きます: :: dst(I)=value-src(I) if mask(I)!=0 .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: SubS cv::SubS -------- .. function:: SubS(src,value,dst,mask=NULL)-> None 配列からスカラー値を引きます. :param src: 入力配列 :type src: :class:`CvArr` :param value: 引き算するスカラー :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,入力配列の各要素からスカラー値を引きます: :: dst(I)=src(I)-value if mask(I)!=0 .. マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. また,有限の範囲に値をとる型は,この処理により飽和します. .. index:: Sum cv::Sum ------- .. function:: Sum(arr)-> CvScalar 配列の要素値の総和を求めます. :param arr: 配列 :type arr: :class:`CvArr` 関数 ``cvSum`` は,各チャンネルごとに配列要素値の総和 ``S`` を求めます: .. math:: \sum _I \texttt{arr} (I)_c 配列が ``IplImage`` で COI が設定されている場合,この関数は指定されたチャンネルのみを処理し,その結果を戻り値の ``CvScalar`` の1番目の要素 :math:`S_0` に格納します. .. index:: SVBkSb cv::SVBkSb ---------- .. function:: SVBkSb(W,U,V,B,X,flags)-> None 特異値の後退代入を行います. :param W: 特異値を対角要素とする行列,あるいは要素とするベクトル :type W: :class:`CvArr` :param U: (左)直交行列(転置されている場合もあります) :type U: :class:`CvArr` :param V: (右)直交行列(転置されている場合もあります) :type V: :class:`CvArr` :param B: 元の行列 ``A`` の擬似逆行列に乗ずるための行列.これは,オプションです.これが省略された場合,適切なサイズの単位行列であると見なされます(その場合は, ``X`` は ``A`` の擬似逆行列となります) :type B: :class:`CvArr` :param X: 出力行列.後退代入の結果 :type X: :class:`CvArr` :param flags: オプションである処理フラグ. :ref:`SVD` に渡された ``flags`` と一致していなければいけません :type flags: int この関数は,特異値分解された行列 ``A`` ( :ref:`SVD` の説明を参照してください)と行列 ``B`` に対して後退代入を行います: .. math:: \texttt{X} = \texttt{V} \texttt{W} ^{-1} \texttt{U} ^T \texttt{B} ここで, .. math:: W^{-1}_{(i,i)}= \fork{1/W_{(i,i)}}{if $W_{(i,i)} > \epsilon \sum_i{W_{(i,i)}}$ }{0}{otherwise} なお, :math:`\epsilon` は,行列のデータ型に依存する微小な値です. この関数は, :ref:`Invert` や :ref:`Solve` の内部で :ref:`SVD` と共に用いられます.これらの「低レベルな」関数( ``SVD`` と ``SVBkSb`` )を用いる状況があるとすれば,これらに対応する高レベルな関数( :ref:`Invert` と :ref:`Solve` )内部でのテンポラリな行列の確保を避けるためでしょう. .. index:: SVD cv::SVD ------- .. function:: SVD(A,W, U = None, V = None, flags=0)-> None 浮動小数点型の実数行列の特異値分解を行います. :param A: :math:`\texttt{M} \times \texttt{N}` の入力行列 :type A: :class:`CvArr` :param W: 特異値分解の結果得られる対角行列( :math:`\texttt{M} \times \texttt{N}` または :math:`\min(\texttt{M}, \texttt{N}) \times \min(\texttt{M}, \texttt{N})` ) あるいは,特異値のベクトル( :math:`\min(\texttt{M},\texttt{N}) \times 1` ) :type W: :class:`CvArr` :param U: オプション.(左)直交行列 :math:`\texttt{M} \times \min(\texttt{M}, \texttt{N})` ( ``CV_SVD_U_T`` が設定されていない場合),または :math:`\min(\texttt{M},\texttt{N}) \times \texttt{M}` ( ``CV_SVD_U_T`` が指定されている場合),または :math:`\texttt{M} \times \texttt{M}` ( ``CV_SVD_U_T`` フラグには無関係) :type U: :class:`CvArr` :param V: オプション.(右)直交行列( :math:`\texttt{N} \times \texttt{N}` ) :type V: :class:`CvArr` :param V: オプション.(右)直行行列 :math:`\texttt{N} \times \min(\texttt{M}, \texttt{N})` ( ``CV_SVD_V_T`` が設定されてない場合),または :math:`\min(\texttt{M},\texttt{N}) \times \texttt{N}` ( ``CV_SVD_V_T`` が設定されている場合),または :math:`\texttt{N} \times \texttt{N}` ( ``CV_SVD_V_T`` フラグには無関係) :type V: :class:`CvArr` :param flags: 処理フラグ,0 あるいは以下の値の組み合わせ: * **CV_SVD_MODIFY_A** 計算中に ``A`` の値を変更できるようになり,計算が高速化されます * **CV_SVD_U_T** ``U`` の転置行列が返されるようになり,計算が高速化されます * **CV_SVD_V_T** ``V`` の転置行列が返されるようになり,計算が高速化されます :type flags: int この関数は,行列 ``A`` を1つの対角行列と2つの直交行列の積に分解します: .. math:: A=U \, W \, V^T ここで :math:`W` は,特異値を対角要素にもつ対角行列であり,特異値を要素とする1次元ベクトルとして表現する事もできます. すべての特異値は非負であり,( :math:`U` と :math:`V` の列と共に)降順にソートされます. SVD アルゴリズムは,数値的に安定しており,その典型的な応用例には以下のものがあります: * 行列 ``A`` が正方かつ正定値対称である場合(例えば,分散共分散行列など)の固有値問題の厳密な解法.この場合の :math:`W` は,固有値を要素とするベクトル/行列となり, :math:`U = V` は固有ベクトルの行列となります. * 劣決定(方程式よりも未知数が多い)連立1次方程式における厳密な解法. * 優決定(未知数よりも方程式が多い)連立1次方程式における最小2乗法による解法.これらの場合は, ``CV_SVD`` フラグが指定された :ref:`Solve` が実行される. * 行列のランク(0 ではない特異値の個数),条件数(最大の特異値と最小の特異値との比),行列式(行列式の絶対値は特異値の直積に等しい)などの様々な特徴量の高精度な計算. .. index:: Trace cv::Trace --------- .. function:: Trace(mat)-> CvScalar 行列のトレースを求めます. :param mat: 入力行列 :type mat: :class:`CvArr` この関数は,入力行列 ``src1`` の対角要素の和を返します. .. math:: tr( \texttt{mat} ) = \sum _i \texttt{mat} (i,i) .. index:: Transform cv::Transform ------------- .. function:: Transform(src,dst,transmat,shiftvec=NULL)-> None 各配列要素に対して,行列変換を行います. :param src: 1 番目の入力配列 :type src: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param transmat: 変換行列 :type transmat: :class:`CvMat` :param shiftvec: オプションである並進ベクトル :type shiftvec: :class:`CvMat` この関数は,配列 ``src`` の各要素に行列変換を施し,その結果を ``dst`` に代入します: .. math:: dst(I) = transmat \cdot src(I) + shiftvec つまり, ``N`` チャンネル配列 ``src`` の各要素を ``N`` 個の要素を持つベクトルとして扱い, :math:`\texttt{M} \times \texttt{N}` の変換行列 ``transmat`` と並進ベクトル ``shiftvec`` によって変換した結果を, ``M`` チャンネル配列 ``dst`` の要素に格納します. 同次座標系の場合, ``transmat`` は :math:`\texttt{M} \times (N+1)` の行列であり,最右列は並進ベクトルとして扱われます. 入出力配列は共に,同じビット深度,同じサイズ(同じ ROI サイズ)でなければいけません.また, ``transmat`` と ``shiftvec`` は,浮動小数点型実数を要素にもつ行列でなくていけません. この関数は,n-次元の点群の幾何学変換,色空間における任意の線形変換,チャンネルの入れ替えなどに利用できます. .. index:: Transpose cv::Transpose ------------- .. function:: Transpose(src,dst)-> None 行列を転置します. :param src: 入力行列 :type src: :class:`CvArr` :param dst: 出力行列 :type dst: :class:`CvArr` この関数は,入力行列 ``src1`` を転置します: .. math:: \texttt{dst} (i,j) = \texttt{src} (j,i) 複素行列の場合,複素数の共役化は行われないので,これとは別に行う必要があることに注意してください:この例として, :ref:`XorS` のサンプルコードを参照してください. .. index:: Xor cv::Xor ------- .. function:: Xor(src1,src2,dst,mask=NULL)-> None 2つの配列の要素毎に,ビット単位の排他的論理和を計算します. :param src1: 1 番目の入力配列 :type src1: :class:`CvArr` :param src2: 2 番目の入力配列 :type src2: :class:`CvArr` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,2つの配列の要素毎にビット単位の排他的論理和を計算します: :: dst(I)=src1(I)^src2(I) if mask(I)!=0 .. 実際の計算の前に,スカラー値は配列と同じ型に変換されます.また,浮動小数点型配列の場合は,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. .. index:: XorS cv::XorS -------- .. function:: XorS(src,value,dst,mask=NULL)-> None スカラー値と配列の要素毎に,ビット単位の排他的論理和を計算する. :param src: 入力配列 :type src: :class:`CvArr` :param value: スカラー値 :type value: :class:`CvScalar` :param dst: 出力配列 :type dst: :class:`CvArr` :param mask: 8ビットシングルチャンネル配列で表されるオプションマスク.指定された配列要素のみが変更されます :type mask: :class:`CvArr` この関数は,スカラー値と配列要素毎に,ビット単位の論理和を計算します: :: dst(I)=src(I)^value if mask(I)!=0 .. 実際の計算の前に,スカラー値は配列と同じ型に変換されます.また,浮動小数点型配列の場合は,それらのビット表現が処理に用いられます.マスクを除くすべての入出力配列は,同じ型,同じサイズ(または ROI サイズ)でなければいけません. このコードは,次のような結果を出力します: :: (1.0,0.0) (0.0,-1.0) (-1.0,0.0) (0.0,1.0) .. .. index:: mGet cv::mGet -------- .. function:: mGet(mat,row,col)-> double シングルチャンネルの浮動小数点型行列の指定された要素を返します. :param mat: 入力行列 :type mat: :class:`CvMat` :param row: 行を指定するインデックス,0 が基準点 :type row: int :param col: 列を指定するインデックス,0 が基準点 :type col: int この関数は, :ref:`GetReal2D` の高速バージョンで,シングルチャンネルの浮動小数点型行列に対してのみ利用できます.これは,インライン展開,配列や要素の種類チェックが最小限,行と列の範囲チェックはデバックモード時のみ,といった理由で高速に動作します. .. index:: mSet cv::mSet -------- .. function:: mSet(mat,row,col,value)-> None シングルチャンネル,浮動小数点型行列の指定された要素を変更します. :param mat: 行列 :type mat: :class:`CvMat` :param row: 行を指定するインデックス,0 が基準点 :type row: int :param col: 列を指定するインデックス,0 が基準点 :type col: int :param value: 行列の要素に指定する新しい値 :type value: float この関数は, :ref:`SetReal2D` の高速バージョンで,シングルチャンネルの浮動小数点型行列に対してのみ利用できます.これは,インライン展開,配列や要素の種類チェックが最小限,行と列の範囲チェックはデバックモード時のみ,といった理由で高速に動作します.