OPERA  1.0
Open source echelle spectrograph reduction pipeline
operaFITSImage Class Reference

Basic operaFITSImage constructor. More...

#include <operaFITSImage.h>

Inheritance diagram for operaFITSImage:

Public Member Functions

 operaFITSImage ()
float * operator[] (unsigned i)
 indexing operator to return a pixel value.
operaFITSImageoperator= (operaFITSImage *b)
 indexing operator to return a pixel value.
operaFITSImageoperator= (operaFITSImage &b)
 assignment operator.
operaFITSImageoperator= (float f)
 assignment operator.
operaFITSImageoperator+= (operaFITSImage *b)
 add/assignment operator.
operaFITSImageoperator+= (operaFITSImage &b)
 add/assignment operator.
operaFITSImageoperator+= (float f)
 add/assignment operator.
operaFITSImageoperator-= (operaFITSImage *b)
 subtract/assignment operator.
operaFITSImageoperator-= (operaFITSImage &b)
 subtract/assignment operator.
operaFITSImageoperator-= (float f)
 subtract/assignment operator.
operaFITSImageoperator*= (operaFITSImage *b)
 mutiply/assignment operator.
operaFITSImageoperator*= (operaFITSImage &b)
 multiply/assignment operator.
operaFITSImageoperator*= (float f)
 multiply/assignment operator.
operaFITSImageoperator/= (operaFITSImage *b)
 divide/assignment operator.
operaFITSImageoperator/= (operaFITSImage &b)
 divide/assignment operator.
operaFITSImageoperator/= (float f)
 divide/assignment operator.
operaFITSImageoperator* (operaFITSImage *b)
 multiply operator.
operaFITSImageoperator* (operaFITSImage &b)
 multiply operator.
operaFITSImageoperator* (float f)
 multiply operator.
operaFITSImageoperator/ (operaFITSImage *b)
 divide operator.
operaFITSImageoperator/ (operaFITSImage &b)
 divide operator.
operaFITSImageoperator/ (float f)
 divide operator.
operaFITSImageoperator+ (operaFITSImage *b)
 add operator.
operaFITSImageoperator+ (operaFITSImage &b)
 add operator.
operaFITSImageoperator+ (float f)
 add operator.
operaFITSImageoperator- (operaFITSImage *b)
 subtract operator.
operaFITSImageoperator- (operaFITSImage &b)
 subtract operator.
operaFITSImageoperator- (float f)
 subtract operator.
operaFITSImageoperator! ()
 invert operator.
operaFITSImageoperator> (operaFITSImage *b)
 greater than operator.
operaFITSImageoperator> (operaFITSImage &b)
 greater than operator.
operaFITSImageoperator> (float f)
 greater than operator.
operaFITSImageoperator>= (operaFITSImage *b)
 greater than or equal operator.
operaFITSImageoperator>= (operaFITSImage &b)
 greater than or equal operator.
operaFITSImageoperator>= (float f)
 greater than or equal operator.
operaFITSImageoperator< (operaFITSImage *b)
 less than operator.
operaFITSImageoperator< (operaFITSImage &b)
 less than operator.
operaFITSImageoperator< (float f)
 less than operator.
operaFITSImageoperator<= (operaFITSImage *b)
 less than or equal operator.
operaFITSImageoperator<= (operaFITSImage &b)
 less than or equal operator.
operaFITSImageoperator<= (float f)
 less than or equal operator.
operaFITSImageoperator&& (operaFITSImage *b)
 and operator.
operaFITSImageoperator&& (operaFITSImage &b)
 less than operator.
operaFITSImageoperator|| (operaFITSImage *b)
 and operator.
operaFITSImageoperator|| (operaFITSImage &b)
 less than operator.
 operaFITSImage (unsigned Naxis1, unsigned Naxis2, edatatype Datatype=tushort, unsigned Compression=0)
 operaFITSImage (string Filename, unsigned Naxis1, unsigned Naxis2, edatatype Datatype=tushort, unsigned Compression=0)
 operaFITSImage (string Filename, edatatype Datatype, int mode=READWRITE)
 operaFITSImage (string Filename, int mode=READWRITE)
 ~operaFITSImage ()
 Clone a FITSImage object.
void operaFITSImageSave ()
 Saves the current image to disk.
void operaFITSImageSaveAs (string newFilename)
 Saves the current image to disk, with the given filename.
operaFITSImageoperaFITSImageClone (operaFITSImage &imageIn)
 Clone a FITSImage object.
unsigned short * operaFITSImageClonePixelsUSHORT ()
 Clone pixel image data.
unsigned short * operaFITSImageClonePixelsUSHORT (unsigned x, unsigned y, unsigned nx, unsigned ny)
 Clone a pixel image subwindow.
float * operaFITSImageClonePixels ()
 Clone float pixel data.
float * operaFITSImageClonePixels (unsigned x, unsigned y, unsigned nx, unsigned ny)
 Clone a float pixel image subwindow.
void operaFITSImageSetData (operaFITSSubImage &subImage, unsigned X, unsigned Y)
 copy a subimage in to an operaFITSImage.
void operaFITSImageSetData (unsigned short *data)
 set the iamge data pointer to a buffer of data.
void operaFITSImageSetData (float *data)
 set the iamge data pointer to a buffer of data.
string operaFITSGetHeaderValue (string keyword)
 returns the value of a FITS keyword with leading trailing quotes and trailing spaces removed.
string operaFITSGetRawHeaderValue (string keyword)
 returns the value of a FITS keyword verbatim.
void operaFITSSetHeaderValue (string keyword, string value, string comment)
 sets the given keyword to value with comment.
void operaFITSSetHeaderValue (string keyword, unsigned short value, string comment)
 sets the given keyword to value with comment.
void operaFITSSetHeaderValue (string keyword, float value, string comment)
 sets the given keyword to value with comment.
void operaFITSSetHeaderValue (string keyword, double value, string comment)
 sets the given keyword to value with comment.
void operaFITSImageCopyHeader (operaFITSImage *from)
 Copies all of the header information from image.
void operaFITSImageConvertImage (edatatype todatatype)
 Convert image type and create new image values of that type.
void transpose ()
 transpose y for x.
void operaFITSImageClose ()
 Close a FITSImage object file.
unsigned short getpixelUSHORT (unsigned x, unsigned y)
 get a pixel value at coordinates x,y.
float getpixel (unsigned x, unsigned y)
void setpixel (unsigned short value, unsigned x, unsigned y)
 get a pixel value at coordinates x,y.
void setpixel (float value, unsigned x, unsigned y)
void setfilename (string name)
 set the image filename.
string getfilename ()
 set the image filename.
fitsfile * getfitsfileptr ()
 get the image FITS file point.
void * getpixels ()
 get the image array base.
Matrix getmatrix ()
 get the matrix base.
unsigned getnaxis ()
 get the image array number of axes (2 in usually).
unsigned getnaxis1 ()
 get the image array length of x dimension.
unsigned getnaxis2 ()
 get the image array length of y dimension.
unsigned getnpixels ()
 get the image array number of pixels.
unsigned long getsize ()
 get the size of an image.
unsigned getelementsize ()
 get the size of a pixel.
unsigned getCompression ()
 get the current compression method.
void setCompression (unsigned Compression)
 set the current compression method.
edatatype getdatatype ()
 get the current datatype
ebitpix getbitpix ()
 get the current bitpix
bool getIstemp ()
 return true if this is a temp.

Protected Member Functions

ebitpix tobitpix (edatatype Datatype)
 returns the bitpix value from given datatype.
edatatype todatatype (ebitpix Bitpix, float bzero, float bscale)
 returns the datatype value from given bitpix, bzero and bscale.
long toSize (ebitpix bitpix, long npixels)
 returns the size of an image array given the bitpix and npixels.

Friends

class operaEspadonsImage
class operaFITSSubImage

Detailed Description

Basic operaFITSImage constructor.

Destructor releases the image array memory and closes the opened fitsfile.

operaFITSImage(string Filename, unsigned Naxis1, unsigned Naxis2, edatatype Datatype, unsigned Compression)

operaFITSImage(string Filename, int mode=READWRITE)

operaFITSImage(unsigned Naxis1, unsigned Naxis2, edatatype Datatype=tushort, unsigned Compression=0)

Returns:
void

an in-memory FITSImage object Create an in-memory image of given dimensions.

Parameters:
Naxis1- x ccd dimension
Naxis2- y ccd dimension
Datatypeoptional datatype defaults to tshort
Compressionoptional compression, defaults to none
Returns:
void

a FITSIMage object from a FITS file Constructor to create a FITSImage from a FITS file.

Parameters:
Filename
mode
Returns:
void

a writeable file image of an in memory FITSImage object Constructor to create a new FITS file.

Parameters:
Filenameto create (file is deleted if it exists)
Naxis1- dimensions
Naxis2- dimensions
Datatypedefaults to tshort
Compression,defaultsto none
Exceptions:
operaExceptioncfitsio error code
Returns:
void

a FITSIMage object from a FITS file Constructor to create a FITSImage from a FITS file.

Parameters:
Filename
Datatype- the type that you widh the image to be (the file itself may be a different datatype)
mode
Note:
converts datatype to that requested
Returns:
void

Constructor & Destructor Documentation

operaFITSImage::operaFITSImage ( )
operaFITSImage::operaFITSImage ( unsigned  Naxis1,
unsigned  Naxis2,
edatatype  Datatype = tushort,
unsigned  Compression = 0 
)

Here is the call graph for this function:

operaFITSImage::operaFITSImage ( string  Filename,
unsigned  Naxis1,
unsigned  Naxis2,
edatatype  Datatype = tushort,
unsigned  Compression = 0 
)

Here is the call graph for this function:

operaFITSImage::operaFITSImage ( string  Filename,
edatatype  Datatype,
int  mode = READWRITE 
)

Here is the call graph for this function:

operaFITSImage::operaFITSImage ( string  Filename,
int  mode = READWRITE 
)
operaFITSImage::~operaFITSImage ( )

Clone a FITSImage object.

operaFITSImage* operaFITSImage::operaFITSImage(operaFITSImage &imageIn)

Parameters:
imageIn- pointer to image to clone
Returns:
operaFITSImage*

Here is the call graph for this function:


Member Function Documentation

ebitpix operaFITSImage::getbitpix ( )

get the current bitpix

ebitpix getbitpix()

Returns:
bitpix
unsigned operaFITSImage::getCompression ( )

get the current compression method.

unsigned getCompression()

Returns:
0 = none or the FITS compression constant (usually RICE_1)
edatatype operaFITSImage::getdatatype ( )

get the current datatype

edatatype getdatatype()

Returns:
datatype
unsigned operaFITSImage::getelementsize ( )

get the size of a pixel.

unsigned long getelementsize()

Returns:
unsigned long sie of the image

unsigned getelementsize()

Returns:
unsigned long sie of the image
string operaFITSImage::getfilename ( )

set the image filename.

string getfilename()

Returns:
string filename
fitsfile * operaFITSImage::getfitsfileptr ( )

get the image FITS file point.

fitsfile *getfitsfileptr()

Returns:
fitsfile *fileptr
bool operaFITSImage::getIstemp ( ) [inline]

return true if this is a temp.

bool getIstemp()

Returns:
bool
Matrix operaFITSImage::getmatrix ( )

get the matrix base.

void *getmatrix()

Returns:
float **matrix

void *getmatrix()

Returns:
matrix base

Here is the call graph for this function:

unsigned operaFITSImage::getnaxis ( )

get the image array number of axes (2 in usually).

unsigned getnaxis()

Returns:
unsigned number of axes
unsigned operaFITSImage::getnaxis1 ( )

get the image array length of x dimension.

unsigned getnaxis1()

Returns:
unsigned length of axis 1
unsigned operaFITSImage::getnaxis2 ( )

get the image array length of y dimension.

unsigned getnaxis2()

Returns:
unsigned length of axis 2
unsigned operaFITSImage::getnpixels ( )

get the image array number of pixels.

unsigned getnpixels()

Returns:
unsigned number of pixels
float operaFITSImage::getpixel ( unsigned  x,
unsigned  y 
) [inline]

Reimplemented in operaEspadonsImage.

void * operaFITSImage::getpixels ( )

get the image array base.

void *getpixels()

Returns:
void *pixels pointer
unsigned short operaFITSImage::getpixelUSHORT ( unsigned  x,
unsigned  y 
) [inline]

get a pixel value at coordinates x,y.

operaFITSImage::getpixel(unsigned x, unsigned y)

Parameters:
x- the x coordinate
y- the y coordinate
Returns:
unsigned short

Reimplemented in operaEspadonsImage.

unsigned long operaFITSImage::getsize ( )

get the size of an image.

unsigned long getsize()

Returns:
unsigned long sie of the image

Reimplemented in operaEspadonsImage.

string operaFITSImage::operaFITSGetHeaderValue ( string  keyword)

returns the value of a FITS keyword with leading trailing quotes and trailing spaces removed.

string operaFITSGetHeaderValue(string keyword)

Parameters:
keyword
Returns:
string keyword value or empty string

Here is the call graph for this function:

string operaFITSImage::operaFITSGetRawHeaderValue ( string  keyword)

returns the value of a FITS keyword verbatim.

string operaFITSGetRawHeaderValue(string keyword)

Parameters:
keyword
Exceptions:
operaExceptioncfitsio error code
Returns:
string keyword value or empty string
operaFITSImage * operaFITSImage::operaFITSImageClone ( operaFITSImage imageIn)

Clone a FITSImage object.

operaFITSImage* operaFITSImage::operaFITSImageClone(operaFITSImage &imageIn)

Parameters:
imageIn- pointer to image to clone
Returns:
operaFITSImage*

Here is the call graph for this function:

float * operaFITSImage::operaFITSImageClonePixels ( )

Clone float pixel data.

float* operaFITSImage::operaFITSImageClonePixels()

Returns:
pixels*
float * operaFITSImage::operaFITSImageClonePixels ( unsigned  x,
unsigned  y,
unsigned  nx,
unsigned  ny 
)

Clone a float pixel image subwindow.

float* operaFITSImage::operaFITSImageClonePixels(unsigned x, unsigned y, unsigned nx, unsigned ny)

Parameters:
x
y
nx
ny
Returns:
pixels*
unsigned short * operaFITSImage::operaFITSImageClonePixelsUSHORT ( )

Clone pixel image data.

unsigned short* operaFITSImage::operaFITSImageClonePixelsUSHORT()

Returns:
pixels*
unsigned short * operaFITSImage::operaFITSImageClonePixelsUSHORT ( unsigned  x,
unsigned  y,
unsigned  nx,
unsigned  ny 
)

Clone a pixel image subwindow.

unsigned short* operaFITSImage::operaFITSImageClonePixelsUSHORT(unsigned x, unsigned y, unisgned nx, unsigned ny)

Parameters:
x
y
nx
ny
Returns:
pixels*
void operaFITSImage::operaFITSImageClose ( )

Close a FITSImage object file.

Clonse a FITSImage object file.

operaFITSImage::operaFITSImageClose()

Returns:
void
void operaFITSImage::operaFITSImageConvertImage ( edatatype  todatatype)

Convert image type and create new image values of that type.

void operaFITSImage::operaFITSImageConvertImage(edatatype todatattype)

Parameters:
todatatypeedatatype to convert to
Exceptions:
operaExceptioncfitsio error code
Returns:
void

Here is the call graph for this function:

void operaFITSImage::operaFITSImageCopyHeader ( operaFITSImage from)

Copies all of the header information from image.

operaFITSImageCopyHeader(operaFITSImage *from)

Parameters:
from
Exceptions:
operaExceptioncfitsio error code
Returns:
void

Here is the call graph for this function:

void operaFITSImage::operaFITSImageSave ( )

Saves the current image to disk.

operaFITSImageSave()

Note:
This is tricky and does some fancy fptr work so that the HDU is retained.
Exceptions:
operaExceptionoperaErrorCodeNoFilename
operaExceptioncfitsio error code
Returns:
void
void operaFITSImage::operaFITSImageSaveAs ( string  newFilename)

Saves the current image to disk, with the given filename.

operaFITSImageSaveAs(string newFilename)

Parameters:
newFilename
Exceptions:
operaExceptioncfitsio error code
Returns:
void
void operaFITSImage::operaFITSImageSetData ( operaFITSSubImage subImage,
unsigned  X,
unsigned  Y 
)

copy a subimage in to an operaFITSImage.

void operaFITSImage::operaFITSImageSetData(operaFITSSubImage &subImage, unsigned X, unsigned Y)

Parameters:
subImagethe subImage
X- beginning x location in image
Y- beginning y location in image
Returns:
void

Here is the call graph for this function:

void operaFITSImage::operaFITSImageSetData ( unsigned short *  data)

set the iamge data pointer to a buffer of data.

set the image data pointer to a buffer of data.

void operaFITSImage::operaFITSImageSetData(unsigned short* data)

Parameters:
datapointer to the data
Returns:
void
void operaFITSImage::operaFITSImageSetData ( float *  data)

set the iamge data pointer to a buffer of data.

set the image data pointer to a buffer of data.

void operaFITSImage::operaFITSImageSetData(float* data)

Parameters:
datapointer to the data
Returns:
void
void operaFITSImage::operaFITSSetHeaderValue ( string  keyword,
string  value,
string  comment 
)

sets the given keyword to value with comment.

operaFITSSetHeaderValue(string keyword, string value, string comment)

Parameters:
keyword
value
comment
Exceptions:
operaExceptioncfitsio error code
Returns:
void
void operaFITSImage::operaFITSSetHeaderValue ( string  keyword,
unsigned short  value,
string  comment 
)

sets the given keyword to value with comment.

operaFITSSetHeaderValue(string keyword, unsigned short value, string comment)

Parameters:
keyword
value
comment
Returns:
void
void operaFITSImage::operaFITSSetHeaderValue ( string  keyword,
float  value,
string  comment 
)

sets the given keyword to value with comment.

operaFITSSetHeaderValue(string keyword, float value, string comment)

Parameters:
keyword
value
comment
Exceptions:
operaExceptioncfitsio error code
Returns:
void
void operaFITSImage::operaFITSSetHeaderValue ( string  keyword,
double  value,
string  comment 
)

sets the given keyword to value with comment.

operaFITSSetHeaderValue(string keyword, double value, string comment)

Parameters:
keyword
value
comment
Exceptions:
operaExceptioncfitsio error code
Returns:
void
operaFITSImage* operaFITSImage::operator! ( ) [inline]

invert operator.

!

Note:
usage: operaFITSImage a = !operaFITSImage b; inverts the pixel values of b and assigns to a (0.0 becomes 1.0, non-zero becomes 0.0)
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator&& ( operaFITSImage b) [inline]

and operator.

&&

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b && operaFITSImage c; creates a mask of 1.0 where b && c != 0.0
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator&& ( operaFITSImage b) [inline]

less than operator.

&&

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b && operaFITSImage c; creates a mask of 1.0 where b && c != 0.0
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator* ( operaFITSImage b) [inline]

multiply operator.

*

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b * operaFITSImage c; multiplies the pixel values b * c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator* ( operaFITSImage b) [inline]

multiply operator.

*

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b * operaFITSImage c; multiplies the pixel values b * c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator* ( float  f) [inline]

multiply operator.

*

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b * 10.0; multiplies the pixel values b * 10.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator*= ( operaFITSImage b) [inline]

mutiply/assignment operator.

*=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a *= operaFITSImage b; multiplies the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator*= ( operaFITSImage b) [inline]

multiply/assignment operator.

*=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a *= operaFITSImage b; multiplies the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator*= ( float  f) [inline]

multiply/assignment operator.

*=

Parameters:
f- float
Note:
usage: operaFITSImage a *= 100.0; multiplies the float value times a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator+ ( operaFITSImage b) [inline]

add operator.

+

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b + operaFITSImage c; adds the pixel values b + c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator+ ( operaFITSImage b) [inline]

add operator.

+

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b + operaFITSImage c; adds the pixel values b + c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator+ ( float  f) [inline]

add operator.

+

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b + 100.0; adds the pixel values b + 100.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator+= ( operaFITSImage b) [inline]

add/assignment operator.

+=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a += operaFITSImage b; adds the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator+= ( operaFITSImage b) [inline]

add/assignment operator.

+=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a += operaFITSImage b; adds the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator+= ( float  f) [inline]

add/assignment operator.

+=

Parameters:
f- float
Note:
usage: operaFITSImage a += 100.0; adds the float value to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator- ( operaFITSImage b) [inline]

subtract operator.

-

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b - operaFITSImage c; subtracts the pixel values b - c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator- ( operaFITSImage b) [inline]

subtract operator.

-

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b - operaFITSImage c; subtracts the pixel values b - c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator- ( float  f) [inline]

subtract operator.

-

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b - 100.0; subtracts the pixel values b - 100.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator-= ( operaFITSImage b) [inline]

subtract/assignment operator.

-=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a -= operaFITSImage b; subtracts the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator-= ( operaFITSImage b) [inline]

subtract/assignment operator.

-=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a -= operaFITSImage b; subtracts the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator-= ( float  f) [inline]

subtract/assignment operator.

-=

Parameters:
f- float
Note:
usage: operaFITSImage a -= 100.0; subtracts the float value from a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator/ ( operaFITSImage b) [inline]

divide operator.

/

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b / operaFITSImage c; divides the pixel values b / c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator/ ( operaFITSImage b) [inline]

divide operator.

/

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b / operaFITSImage c; divides the pixel values b / c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator/ ( float  f) [inline]

divide operator.

/

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b / 100.0; divides the pixel values b / 100.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator/= ( operaFITSImage b) [inline]

divide/assignment operator.

/=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a /= operaFITSImage b; divides the pixel values from b into a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator/= ( operaFITSImage b) [inline]

divide/assignment operator.

/=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a /= operaFITSImage b; divides the pixel values from b into a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator/= ( float  f) [inline]

divide/assignment operator.

/=

Parameters:
f- float
Note:
usage: operaFITSImage a /= 100.0; divides the float value from a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator< ( operaFITSImage b) [inline]

less than operator.

<

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b < operaFITSImage c; creates a mask of 1.0 if b < c or 0.0 if b >= c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator< ( operaFITSImage b) [inline]

less than operator.

<

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b < operaFITSImage c; creates a mask of 1.0 if b < c or 0.0 if b >= c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator< ( float  f) [inline]

less than operator.

<

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b < operaFITSImage c; creates a mask of 1.0 if b < c or 0.0 if b >= c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator<= ( operaFITSImage b) [inline]

less than or equal operator.

<=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b <= operaFITSImage c; creates a mask of 1.0 if b <= c or 0.0 if b > c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator<= ( operaFITSImage b) [inline]

less than or equal operator.

<=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b <= operaFITSImage c; creates a mask of 1.0 if b <= c or 0.0 if b > c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator<= ( float  f) [inline]

less than or equal operator.

<=

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b <= 100.0; creates a mask of 1.0 if b <= 100.0 or 0.0 if b > 100.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator= ( operaFITSImage b) [inline]

indexing operator to return a pixel value.

[]

Parameters:
v- ImageIndexVector
Note:
usage:
Returns:
operaFITSSubImage pointer

= assignment operator.

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b; copies the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator= ( operaFITSImage b) [inline]

assignment operator.

=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b; copies the pixel values from b to a
Returns:
operaFITSImage&
operaFITSImage& operaFITSImage::operator= ( float  f) [inline]

assignment operator.

=

Parameters:
f- float
Note:
usage: operaFITSImage a = 0.0; copies the float value to every pixel in = a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator> ( operaFITSImage b) [inline]

greater than operator.

>

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b > operaFITSImage c; creates a mask of 1.0 if b > c or 0.0 if b <= c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator> ( operaFITSImage b) [inline]

greater than operator.

>

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b > operaFITSImage c; creates a mask of 1.0 if b > c or 0.0 if b <= c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator> ( float  f) [inline]

greater than operator.

>

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b > 100.0; creates a mask of 1.0 if b > 100.0 or 0.0 if b <= 100.0 and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator>= ( operaFITSImage b) [inline]

greater than or equal operator.

>=

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b >= operaFITSImage c; creates a mask of 1.0 if b >= c or 0.0 if b < c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator>= ( operaFITSImage b) [inline]

greater than or equal operator.

>=

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b >= operaFITSImage c; creates a mask of 1.0 if b >= c or 0.0 if b < c and assigns to a
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator>= ( float  f) [inline]

greater than or equal operator.

>=

Parameters:
f- float
Note:
usage: operaFITSImage a = operaFITSImage b >= 100.0; creates a mask of 1.0 if b >= 100.0 or 0.0 if b < 100.0 and assigns to a
Returns:
operaFITSImage&
float* operaFITSImage::operator[] ( unsigned  i) [inline]

indexing operator to return a pixel value.

[]

Parameters:
i- index into row
Note:
usage: myfitsimage[y][x] = 0.0; sets the image pixel value at coords x, y to zero
Returns:
float pointer to row
operaFITSImage* operaFITSImage::operator|| ( operaFITSImage b) [inline]

and operator.

||

Parameters:
b- operaFITSImage*
Note:
usage: operaFITSImage a = operaFITSImage b && operaFITSImage c; creates a mask of 1.0 where b != 0.0 || c != 0.0
Returns:
operaFITSImage&
operaFITSImage* operaFITSImage::operator|| ( operaFITSImage b) [inline]

less than operator.

||

Parameters:
b- operaFITSImage&
Note:
usage: operaFITSImage a = operaFITSImage b && operaFITSImage c; creates a mask of 1.0 where b && c != 0.0
Returns:
operaFITSImage&
void operaFITSImage::setCompression ( unsigned  Compression)

set the current compression method.

void getCompression(nsigned Compression)

Parameters:
Compression0 = none or the FITS compression constant (usually RICE_1)
Returns:
void
void operaFITSImage::setfilename ( string  Filename)

set the image filename.

setfilename(string Filename)

Parameters:
Filename
Returns:
void
void operaFITSImage::setpixel ( unsigned short  value,
unsigned  x,
unsigned  y 
) [inline]

get a pixel value at coordinates x,y.

operaFITSImage::setpixel(float value, unsigned x, unsigned y)

Parameters:
value- the float pixel value
x- the x coordinate
y- the y coordinate
Returns:
unsigned short

Reimplemented in operaEspadonsImage.

void operaFITSImage::setpixel ( float  value,
unsigned  x,
unsigned  y 
) [inline]

Reimplemented in operaEspadonsImage.

ebitpix operaFITSImage::tobitpix ( edatatype  Datatype) [protected]

returns the bitpix value from given datatype.

ebitpix tobitpix(edatatype Datatype)

Note:
PRIVATE
Parameters:
Datatype
Returns:
ebitpix
edatatype operaFITSImage::todatatype ( ebitpix  Bitpix,
float  bzero,
float  bscale 
) [protected]

returns the datatype value from given bitpix, bzero and bscale.

edatatype todatatype(ebitpix Bitpix, float bzero, float bscale)

Note:
if bzero == 32768. and bscale == 1. then datatype = tushort else tshort
PRIVATE
Parameters:
Bitpix
bzero
bscale
Returns:
edatatype
long operaFITSImage::toSize ( ebitpix  bitpix,
long  npixels 
) [protected]

returns the size of an image array given the bitpix and npixels.

long toSize(ebitpix bitpix, long npixels)

Note:
PRIVATE
Parameters:
bitpix
npixels
Returns:
size
void operaFITSImage::transpose ( )

transpose y for x.

operaFITSImage::transpose()

Returns:
void

Here is the call graph for this function:


Friends And Related Function Documentation

friend class operaEspadonsImage [friend]
friend class operaFITSSubImage [friend]

The documentation for this class was generated from the following files: