SLLIB + SFITSIO ダイジェスト版 HTML マニュアル

idx1，idx2 は省略可能で，引数の個数によってn次元のデータを， 1次元，2次元あるいは3次元(以上)として扱う事ができます．

定数 FITS::INDEF を明示的に使わないでください．

返り値

自身の参照

fits_image &convert_type( int new_type );
fits_image &convert_type( int new_type, double new_zero );
fits_image &convert_type( int new_type, double new_zero, double new_scale );
fits_image &convert_type( int new_type, double new_zero, 
                          double new_scale, long long new_blank );

イメージの データ型 を new_type に変換します．必要に応じて，画像バッファのバイトサイズも変更します．

new_type に指定できる値は， FITS::DOUBLE_T， FITS::FLOAT_T， FITS::LONGLONG_T， FITS::LONG_T， FITS::SHORT_T， FITS::BYTE_T のいずれかです． new_zero， new_scale，new_blank を指定した場合は， ヘッダの BZERO，BSCALE，BLANK の値も変更し，それらの値を反映したイメージデータに変換します． new_blank が有効なのは，new_type が整数型の場合のみです．

返り値

自身の参照

double bzero() const;
bool bzero_is_set() const;
fits_image &assign_bzero( double zero, int prec = 15 );
fits_image &erase_bzero();

bzero()メンバ関数は，ヘッダの BZERO の値を返します．

bzero_is_set()メンバ関数は，ヘッダの BZERO の有無を返します．

assign_bzero()メンバ関数は， ヘッダの BZEROの値を設定します． prec には桁数を指定できます．省略した場合， 15桁の精度でヘッダレコードに書き込みます．

erase_bzero()メンバ関数は， ヘッダのBZEROを消去します．

assign_bzero()メンバ関数と erase_bzero()メンバ関数は， 自身の参照を返します．

これらのメンバ関数では画像データのゼロ点は変化しません． 画像データも同時に変更したい場合は， convert_type()メンバ関数を使います．

double bscale() const;
bool bscale_is_set() const;
fits_image &assign_bscale( double scale, int prec = 15 );
fits_image &erase_bscale();

bscale()メンバ関数は， ヘッダのBSCALEの値を返します．

bscale_is_set()メンバ関数は， ヘッダのBSCALEの有無を返します．

assign_bscale()メンバ関数は， ヘッダのBSCALEの値を設定します． prec には桁数を指定できます．省略した場合， 15桁の精度でヘッダレコードに書き込みます．

erase_bscale()メンバ関数は， ヘッダのBSCALEを消去します．

assign_bscale()メンバ関数と erase_bscale()メンバ関数は， 自身の参照を返します．

これらのメンバ関数では画像データのスケーリングファクターは変化しません． 画像データも同時に変更したい場合は， convert_type()メンバ関数を使います．

long long blank() const;
bool blank_is_set() const;
fits_image &assign_blank( long long blank );
fits_image &erase_blank();

blank()メンバ関数は， ヘッダのBLANKの値を返します．

blank_is_set()メンバ関数は， ヘッダのBLANKの有無を返します．

assign_blank()メンバ関数は， ヘッダのBLANKの値を設定します．

erase_blank()メンバ関数は， ヘッダのBLANKを消去します．

assign_blank()メンバ関数と erase_blank()メンバ関数は， 自身の参照を返します．

fits::byte_t *byte_t_ptr();
const fits::byte_t *byte_t_ptr() const;
const fits::byte_t *byte_t_ptr_cs() const;
fits::short_t *short_t_ptr();
const fits::short_t *short_t_ptr() const;
const fits::short_t *short_t_ptr_cs() const;
fits::long_t *long_t_ptr();
const fits::long_t *long_t_ptr() const;
const fits::long_t *long_t_ptr_cs() const;
fits::longlong_t *longlong_t_ptr();
const fits::longlong_t *longlong_t_ptr() const;
const fits::longlong_t *longlong_t_ptr_cs() const;
fits::float_t *float_t_ptr();
const fits::float_t *float_t_ptr() const;
const fits::float_t *float_t_ptr_cs() const;
fits::double_t *double_t_ptr();
const fits::double_t *double_t_ptr() const;
const fits::double_t *double_t_ptr_cs() const;

画像データ配列のバッファアドレスを返します． 現在の画像データの データ型 に応じて，適切なメンバ関数を使用してください．

ピクセル値に高速なアクセスを行なうために使用します．

返される値はオブジェクト内部バッファのアドレスですから， オブジェクトが破棄されたり， バッファの型やサイズが変更された場合は無効になります．

呼び出されたメンバ関数が，自身のデータ型に不適切な場合は 例外が発生します．

fits::byte_t *const *byte_t_ptr_2d( bool use );
fits::short_t *const *short_t_ptr_2d( bool use );
fits::long_t *const *long_t_ptr_2d( bool use );
fits::longlong_t *const *longlong_t_ptr_2d( bool use );
fits::float_t *const *float_t_ptr_2d( bool use );
fits::double_t *const *double_t_ptr_2d( bool use );
fits::byte_t *const *byte_t_ptr_2d();
const fits::byte_t *const *byte_t_ptr_2d() const;
const fits::byte_t *const *byte_t_ptr_2d_cs() const;
fits::short_t *const *short_t_ptr_2d();
const fits::short_t *const *short_t_ptr_2d() const;
const fits::short_t *const *short_t_ptr_2d_cs() const;
fits::long_t *const *long_t_ptr_2d();
const fits::long_t *const *long_t_ptr_2d() const;
const fits::long_t *const *long_t_ptr_2d_cs() const;
fits::longlong_t *const *longlong_t_ptr_2d();
const fits::longlong_t *const *longlong_t_ptr_2d() const;
const fits::longlong_t *const *longlong_t_ptr_2d_cs() const;
fits::float_t *const *float_t_ptr_2d();
const fits::float_t *const *float_t_ptr_2d() const;
const fits::float_t *const *float_t_ptr_2d_cs() const;
fits::double_t *const *double_t_ptr_2d();
const fits::double_t *const *double_t_ptr_2d() const;
const fits::double_t *const *double_t_ptr_2d_cs() const;

オブジェクト内部で生成された2次元画像データ配列のためのポインタ配列 のアドレスを返します． 現在の画像データの データ型 に応じて，適切なメンバ関数を使用してください．

2次元データに高速なアクセスを行なうために使用します．

デフォルトではオブジェクト内部でのポインタ配列は生成されません． 生成されるするには，引数 use に true をセットして一度メンバ関数を呼び出してください．

返される値はオブジェクト内部バッファのアドレスですから， オブジェクトが破棄されたり， バッファの型やサイズが変更された場合は無効になります．

呼び出されたメンバ関数が，自身のデータ型に不適切な場合は 例外が発生します．

fits::byte_t *const *const *byte_t_ptr_3d( bool use );
fits::short_t *const *const *short_t_ptr_3d( bool use );
fits::long_t *const *const *long_t_ptr_3d( bool use );
fits::longlong_t *const *const *longlong_t_ptr_3d( bool use );
fits::float_t *const *const *float_t_ptr_3d( bool use );
fits::double_t *const *const *double_t_ptr_3d( bool use );
fits::byte_t *const *const *byte_t_ptr_3d();
const fits::byte_t *const *const *byte_t_ptr_3d() const;
const fits::byte_t *const *const *byte_t_ptr_3d_cs() const;
fits::short_t *const *const *short_t_ptr_3d();
const fits::short_t *const *const *short_t_ptr_3d() const;
const fits::short_t *const *const *short_t_ptr_3d_cs() const;
fits::long_t *const *const *long_t_ptr_3d();
const fits::long_t *const *const *long_t_ptr_3d() const;
const fits::long_t *const *const *long_t_ptr_3d_cs() const;
fits::longlong_t *const *const *longlong_t_ptr_3d();
const fits::longlong_t *const *const *longlong_t_ptr_3d() const;
const fits::longlong_t *const *const *longlong_t_ptr_3d_cs() const;
fits::float_t *const *const *float_t_ptr_3d();
const fits::float_t *const *const *float_t_ptr_3d() const;
const fits::float_t *const *const *float_t_ptr_3d_cs() const;
fits::double_t *const *const *double_t_ptr_3d();
const fits::double_t *const *const *double_t_ptr_3d() const;
const fits::double_t *const *const *double_t_ptr_3d_cs() const;

オブジェクト内部で生成された3次元画像データ配列のためのポインタ配列 のアドレスを返します．現在の画像データの データ型 に応じて，適切なメンバ関数を使用してください．

3次元データに高速なアクセスを行なうために使用します．

デフォルトではオブジェクト内部でのポインタ配列は生成されません． 生成されるするには，引数 use に true をセットして一度メンバ関数を呼び出してください．

返される値はオブジェクト内部バッファのアドレスですから， オブジェクトが破棄されたり， バッファのデータ型やサイズが変更された場合は無効になります．

呼び出されたメンバ関数が，自身のデータ型に不適切な場合は 例外が発生します．

mdarray_uchar &uchar_array();
const mdarray_uchar &uchar_array() const;
const mdarray_uchar &uchar_array_cs() const;
mdarray_int16 &int16_array();
const mdarray_int16 &int16_array() const;
const mdarray_int16 &int16_array_cs() const;
mdarray_int32 &int32_array();
const mdarray_int32 &int32_array() const;
const mdarray_int32 &int32_array_cs() const;
mdarray_int64 &int64_array();
const mdarray_int64 &int64_array() const;
const mdarray_int64 &int64_array_cs() const;
mdarray_float &float_array();
const mdarray_float &float_array() const;
const mdarray_float &float_array_cs() const;
mdarray_double &double_array();
const mdarray_double &double_array() const;
const mdarray_double &double_array_cs() const;

画像データ配列オブジェクト(mdarray_* オブジェクト) の参照を返します． 現在の画像データの データ型 に応じて，適切なメンバ関数を使用してください． これらのメンバ関数により取得した参照を経由して， mdarray_*クラスの 多彩で高速なAPIを利用する事ができます．

速度が重視される画素数の多い画像のデータ解析の場合には， SLLIBの単純な実装によるAPIを使ってコーディングを行なう事で， 全体的なパフォーマンスアップが可能です．

呼び出されたメンバ関数が，自身のデータ型に不適切な場合は 例外が発生します．

画像データの編集のためのメンバ関数

fits_image &assign_default( double value );

resize_2d()，resize() 等で画像データの要素長を大きくした場合の 新規ピクセルのデフォルト値を設定します．

assign_default()は高レベルなメンバ関数で， ヘッダの BZERO，BSCALE，BLANK の値が反映されます． BLANK値をセットしたい場合は NAN をセットします．

返り値

自身の参照

fits_image &resize_1d( long x_len );

自身が持つ画像データ配列の長さを変更し，配列長 x_len の1次元配列とします．

返り値

自身の参照

fits_image &resize_2d( long x_len, long y_len );

自身が持つ画像データ配列の長さを変更し，配列長 (x_len, y_len) の2次元配列とします．

返り値

自身の参照

fits_image &resize_3d( long x_len, long y_len, long z_len );

自身が持つ画像データ配列の長さを変更し，配列長 (x_len, y_len, z_len) の3次元配列とします．

返り値

自身の参照

fits_image &increase_dim();

軸を1つ追加します． 追加した軸のピクセル数の初期値は1です．

ピクセル数を増やすには，resize() メンバ関数を使います．

返り値

自身の参照

fits_image &decrease_dim();

軸を1つ減らします． 最も大きな次元の軸のピクセル数が1ではない場合， 内部バッファのバイトサイズも同時に変更します．

返り値

自身の参照

fits_image &resize( long axis, long size );                           ... 1
fits_image &resize( const long naxisx[], long ndim, bool buf_init );  ... 2

メンバ関数1は， 軸 axis のピクセル数を size に変更します． ピクセル数を増やした場合，増えた部分はヘッダの BZERO， BSCALE の値を反映したゼロ値で初期化されます． この初期化が不要な場合は，メンバ関数2を使います．

メンバ関数2は， 配列 naxisx[] に設定されたそれぞれ次元の要素数に従って， 自身が持つ画像データ配列の長さを変更します． ndim に次元数を，buf_init に新規追加された部分のバッファ初期化の可否を指定します．

返り値

自身の参照

fits_image &reallocate( const long naxisx[], long ndim, bool buf_init );

画像データ配列のバッファ内位置に調整をせずに， 自身が持つ次元の大きさと配列の長さを変更します． つまり，配列用バッファに対しては単純に realloc() を呼ぶだけの処理を行ないます．

配列 naxisx[] にそれぞれ次元の要素数を，ndim に次元数を，buf_init に新規追加された部分のバッファ初期化の可否を指定します．

返り値

自身の参照

fits_image &allocate( const long naxisx[], long ndim, bool buf_init );

画像データ配列の内容を一旦破棄し，配列の長さを変更します． つまり，配列用バッファに対して free()，malloc() を呼ぶだけの処理を行ないます．

配列 naxisx[] にそれぞれ次元の要素数を，ndim に次元数を，buf_init に画像バッファ初期化の可否を指定します．

返り値

自身の参照

fits_image &swap( long dim_index, long idx_src, long len, long idx_dst );

自身の画像データ配列の要素間で値を入れ替えます．

次元番号 dim_index の要素番号 idx_src から len 個分の要素を， 要素番号 idx_dst から len 個分の要素と入れ替えます．

idx_dst + len が配列サイズを超える場合は，配列サイズまでの処理が行われます． 入れ替える領域が重なった場合，重なっていない src の領域に対してのみ入れ替え処理が行われます．

返り値

自身の参照

fits_image &move( long dim_index, 
                  long idx_src, long len, long idx_dst, bool clr );

自身の画像データ配列の要素間で値をコピーします． dim_index で処理対象とする次元(次元番号)を， idx_src にコピー元の要素番号を， len にコピーされる要素の長さを， idx_dst コピー先の要素番号を指定します．

引数 clr に false が指定された場合はコピー元の値は残りますが， true が指定された場合はコピー元の値は残らずデフォルト値で埋められます． デフォルト値は assign_default() メンバ関数で指定します．

idx_dst に既存の配列長より大きな値を設定しても，配列サイズは変わりません． この点が次の cpy()メンバ関数とは異なります．

返り値

自身の参照

fits_image &cpy( long dim_index, 
                 long idx_src, long len, long idx_dst, bool clr );

自身の画像データ配列要素間で値をコピーします． dim_index で処理対象とする次元(次元番号)を， idx_src にコピー元の要素番号を， len にコピーされる要素の長さを， idx_dst コピー先の要素番号を指定します．

引数 clr に false が指定された場合はコピー元の値は残りますが， true が指定された場合はコピー元の値は残らずデフォルト値で埋められます． デフォルト値は assign_default() メンバ関数で指定します．

idx_dst + len が既存の配列長より大きい場合，配列サイズは自動拡張されます．

返り値

自身の参照

fits_image &insert( size_t dim_index, long idx, size_t len );

自身の画像データ配列の， 次元番号 dim_index の次元について，要素位置 idx に，len 個分の要素を挿入します．

挿入される要素の値はデフォルト値です． デフォルト値は assign_default() メンバ関数で指定します．

返り値

自身の参照

fits_image &crop( long dim_index, long idx, long len );

自身の画像データ配列の， 次元番号 dim_index の次元について， 要素位置 idx から len 個の要素だけにします(配列の不要部分の消去します)．

返り値

自身の参照

fits_image &flip( long dim_index, long idx, long len );

自身の画像データ配列の， 次元番号 dim_index の次元について， 要素位置 idx から len 個の要素を反転させます．

返り値

自身の参照

fits_image &erase( size_t dim_index, long idx, size_t len );

自身の画像データ配列の， 次元番号 dim_index の次元について， 要素位置 idx から len 個の要素を削除します． 削除した分，長さは短くなります．

返り値

自身の参照

fits_image &transpose_xy();

自身の画像データ配列のカラム(x)とロウ(y)とを入れ替えます．

高速に動作させるためのアルゴリズムを使用しています．

返り値

自身の参照

fits_image &transpose_xyz2zxy();

自身の画像データ配列の軸 (x,y,z) を (z,x,y) へ変換します．

高速に動作させるためのアルゴリズムを使用しています．

返り値

自身の参照

fits_image &rotate_xy( int angle );

自身の画像データ配列の (x, y) 面についての回転(90度単位)を 行ないます． 左下を原点とした場合，反時計まわりで指定します．

返り値

自身の参照

IDLライクな表記で画像データの配列を操作するためのメンバ関数

fits_image &resizef( const char *exp_fmt, ... );

自身が持つ画像データ配列の長さを変更します． 長さの指定は，printf() 形式の可変長引数で指定可能なカンマ区切りの文字列 (例えば"10,5")によって行ないます．

指定された文字列中の要素が数字ではない場合，その次元は長さを変更しません． 例えば， ",2" が指定された場合，最初の次元の長さは変更されません．

返り値

自身の参照

fits_image sectionf( const char *exp_fmt, ... ) const;

自身の画像データ配列のうち指定された部分だけを テンポラリオブジェクトにコピーし，それを返します． 取り出されるされる範囲は任意の次元まで指定可能で "0:99,*" のように IDL や IRAF と同様の文字列で指定します． この文字列中の要素番号は 0-indexed です． なお，"[1:100,*]" のように [] で囲むと，1-indexed として扱われます．

void copyf( fits_image *dest, const char *exp_fmt, ... ) const;

fits_image &trimf( const char *exp_fmt, ... );

fits_image &flipf( const char *exp_fmt, ... );

void transposef_xy_copy( fits_image *dest, const char *exp_fmt, ... ) const;

void transposef_xyz2zxy_copy( fits_image *dest, const char *exp_fmt, ... ) const;

fits_image &cleanf( const char *exp_fmt, ... );

fits_image &fillf( double value, const char *exp_fmt, ... );

fits_image &addf( double value, const char *exp_fmt, ... );

fits_image &subtractf( double value, const char *exp_fmt, ... );

fits_image &multiplyf( double value, const char *exp_fmt, ... );

fits_image &dividef( double value, const char *exp_fmt, ... );

fits_image &pastef( const fits_image &src, const char *exp_fmt, ... );

fits_image &addf( const fits_image &src_img, const char *exp_fmt, ... );

fits_image &subtractf( const fits_image &src_img, const char *exp_fmt, ... );

fits_image &multiplyf( const fits_image &src_img, const char *exp_fmt, ... );

fits_image &dividef( const fits_image &src_img, const char *exp_fmt, ... );