![]() |
ROOT
6.06/08
Reference Guide
|
FITS file interface class.
TFITSHDU is a class that allows extracting images and data from FITS files and contains several methods to manage them.
Classes | |
| union | Cell |
| struct | Column |
| struct | HDURecord |
Public Types | |
| enum | EHDUTypes { kImageHDU, kTableHDU } |
| enum | EColumnTypes { kRealNumber, kString, kRealVector } |
Public Types inherited from TObject | |
| enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
| enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
| enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
Public Member Functions | |
| TFITSHDU (const char *filepath_with_filter) | |
| TFITSHDU constructor from file path with HDU selection filter. More... | |
| TFITSHDU (const char *filepath, Int_t extension_number) | |
| TFITSHDU constructor from filepath and extension number. More... | |
| TFITSHDU (const char *filepath, const char *extension_name) | |
| TFITSHDU constructor from filepath and extension name. More... | |
| ~TFITSHDU () | |
| TFITSHDU destructor. More... | |
| Int_t | GetRecordNumber () const |
| struct HDURecord * | GetRecord (const char *keyword) |
| Get record by keyword. More... | |
| TString & | GetKeywordValue (const char *keyword) |
| Get the value of a given keyword. Return "" if not found. More... | |
| void | Print (const Option_t *opt="") const |
| Print metadata. More... | |
| TH1 * | ReadAsHistogram () |
| Read image HDU as a histogram. More... | |
| TImage * | ReadAsImage (Int_t layer=0, TImagePalette *pal=0) |
| Read image HDU as a displayable image. More... | |
| TMatrixD * | ReadAsMatrix (Int_t layer=0, Option_t *opt="") |
| Read image HDU as a matrix. More... | |
| TVectorD * | GetArrayRow (UInt_t row) |
| Get a row from the image HDU when it's a 2D array. More... | |
| TVectorD * | GetArrayColumn (UInt_t col) |
| Get a column from the image HDU when it's a 2D array. More... | |
| Int_t | GetTabNColumns () const |
| Int_t | GetTabNRows () const |
| Int_t | GetColumnNumber (const char *colname) |
| Get column number given its name. More... | |
| const TString & | GetColumnName (Int_t colnum) |
| Get the name of a column given its index (column>=0). More... | |
| TObjArray * | GetTabStringColumn (Int_t colnum) |
| Get a string-typed column from a table HDU given its column index (>=0). More... | |
| TObjArray * | GetTabStringColumn (const char *colname) |
| Get a string-typed column from a table HDU given its name. More... | |
| TVectorD * | GetTabRealVectorColumn (Int_t colnum) |
| Get a real number-typed column from a table HDU given its column index (>=0). More... | |
| TVectorD * | GetTabRealVectorColumn (const char *colname) |
| Get a real number-typed column from a table HDU given its name. More... | |
| TVectorD * | GetTabRealVectorCell (Int_t rownum, Int_t colnum) |
| Get a real vector embedded in a cell given by (row>=0, column>=0) More... | |
| TVectorD * | GetTabRealVectorCell (Int_t rownum, const char *colname) |
| Get a real vector embedded in a cell given by (row>=0, column name) More... | |
| TObjArray * | GetTabRealVectorCells (Int_t colnum) |
| Get a collection of real vectors embedded in cells along a given column from a table HDU. colnum >= 0. More... | |
| TObjArray * | GetTabRealVectorCells (const char *colname) |
| Get a collection of real vectors embedded in cells along a given column from a table HDU by name. More... | |
| void | Draw (Option_t *opt="") |
| If the HDU is an image, draw the first layer of the primary array To set a title to the canvas, pass it in "opt". More... | |
| Bool_t | Change (const char *filter) |
| Change to another HDU given by "filter". More... | |
| Bool_t | Change (Int_t extension_number) |
| Change to another HDU given by extension_number. More... | |
Public Member Functions inherited from TNamed | |
| TNamed () | |
| TNamed (const char *name, const char *title) | |
| TNamed (const TString &name, const TString &title) | |
| TNamed (const TNamed &named) | |
| TNamed copy ctor. More... | |
| TNamed & | operator= (const TNamed &rhs) |
| TNamed assignment operator. More... | |
| virtual | ~TNamed () |
| virtual void | Clear (Option_t *option="") |
| Set name and title to empty strings (""). More... | |
| virtual TObject * | Clone (const char *newname="") const |
| Make a clone of an object using the Streamer facility. More... | |
| virtual Int_t | Compare (const TObject *obj) const |
| Compare two TNamed objects. More... | |
| virtual void | Copy (TObject &named) const |
| Copy this to obj. More... | |
| virtual void | FillBuffer (char *&buffer) |
| Encode TNamed into output buffer. More... | |
| virtual const char * | GetName () const |
| Returns name of object. More... | |
| virtual const char * | GetTitle () const |
| Returns title of object. More... | |
| virtual ULong_t | Hash () const |
| Return hash value for this object. More... | |
| virtual Bool_t | IsSortable () const |
| virtual void | SetName (const char *name) |
| Change (i.e. More... | |
| virtual void | SetNameTitle (const char *name, const char *title) |
| Change (i.e. set) all the TNamed parameters (name and title). More... | |
| virtual void | SetTitle (const char *title="") |
| Change (i.e. set) the title of the TNamed. More... | |
| virtual void | ls (Option_t *option="") const |
| List TNamed name and title. More... | |
| virtual void | Print (Option_t *option="") const |
| Print TNamed name and title. More... | |
| virtual Int_t | Sizeof () const |
| Return size of the TNamed part of the TObject. More... | |
Public Member Functions inherited from TObject | |
| TObject () | |
| TObject constructor. More... | |
| TObject (const TObject &object) | |
| TObject copy ctor. More... | |
| TObject & | operator= (const TObject &rhs) |
| TObject assignment operator. More... | |
| virtual | ~TObject () |
| TObject destructor. More... | |
| virtual void | AppendPad (Option_t *option="") |
| Append graphics object to current pad. More... | |
| virtual void | Browse (TBrowser *b) |
| Browse object. May be overridden for another default action. More... | |
| virtual const char * | ClassName () const |
| Returns name of class to which the object belongs. More... | |
| virtual void | Delete (Option_t *option="") |
| Delete this object. More... | |
| virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
| Computes distance from point (px,py) to the object. More... | |
| virtual void | DrawClass () const |
| Draw class inheritance tree of the class to which this object belongs. More... | |
| virtual TObject * | DrawClone (Option_t *option="") const |
| Draw a clone of this object in the current pad. More... | |
| virtual void | Dump () const |
| Dump contents of object on stdout. More... | |
| virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
| Execute method on this object with the given parameter string, e.g. More... | |
| virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
| Execute method on this object with parameters stored in the TObjArray. More... | |
| virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
| Execute action corresponding to an event at (px,py). More... | |
| virtual TObject * | FindObject (const char *name) const |
| Must be redefined in derived classes. More... | |
| virtual TObject * | FindObject (const TObject *obj) const |
| Must be redefined in derived classes. More... | |
| virtual Option_t * | GetDrawOption () const |
| Get option used by the graphics system to draw this object. More... | |
| virtual UInt_t | GetUniqueID () const |
| Return the unique object id. More... | |
| virtual const char * | GetIconName () const |
| Returns mime type name of object. More... | |
| virtual Option_t * | GetOption () const |
| virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
| Returns string containing info about the object at position (px,py). More... | |
| virtual Bool_t | HandleTimer (TTimer *timer) |
| Execute action in response of a timer timing out. More... | |
| virtual Bool_t | InheritsFrom (const char *classname) const |
| Returns kTRUE if object inherits from class "classname". More... | |
| virtual Bool_t | InheritsFrom (const TClass *cl) const |
| Returns kTRUE if object inherits from TClass cl. More... | |
| virtual void | Inspect () const |
| Dump contents of this object in a graphics canvas. More... | |
| virtual Bool_t | IsFolder () const |
| Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
| virtual Bool_t | IsEqual (const TObject *obj) const |
| Default equal comparison (objects are equal if they have the same address in memory). More... | |
| Bool_t | IsOnHeap () const |
| Bool_t | IsZombie () const |
| virtual Bool_t | Notify () |
| This method must be overridden to handle object notification. More... | |
| virtual void | Paint (Option_t *option="") |
| This method must be overridden if a class wants to paint itself. More... | |
| virtual void | Pop () |
| Pop on object drawn in a pad to the top of the display list. More... | |
| virtual Int_t | Read (const char *name) |
| Read contents of object with specified name from the current directory. More... | |
| virtual void | RecursiveRemove (TObject *obj) |
| Recursively remove this object from a list. More... | |
| virtual void | SaveAs (const char *filename="", Option_t *option="") const |
| Save this object in the file specified by filename. More... | |
| virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
| Save a primitive as a C++ statement(s) on output stream "out". More... | |
| virtual void | SetDrawOption (Option_t *option="") |
| Set drawing option for object. More... | |
| virtual void | SetUniqueID (UInt_t uid) |
| Set the unique object id. More... | |
| virtual void | UseCurrentStyle () |
| Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More... | |
| virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
| Write this object to the current directory. More... | |
| virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
| Write this object to the current directory. More... | |
| void * | operator new (size_t sz) |
| void * | operator new[] (size_t sz) |
| void * | operator new (size_t sz, void *vp) |
| void * | operator new[] (size_t sz, void *vp) |
| void | operator delete (void *ptr) |
| Operator delete. More... | |
| void | operator delete[] (void *ptr) |
| Operator delete []. More... | |
| void | SetBit (UInt_t f, Bool_t set) |
| Set or unset the user status bits as specified in f. More... | |
| void | SetBit (UInt_t f) |
| void | ResetBit (UInt_t f) |
| Bool_t | TestBit (UInt_t f) const |
| Int_t | TestBits (UInt_t f) const |
| void | InvertBit (UInt_t f) |
| virtual void | Info (const char *method, const char *msgfmt,...) const |
| Issue info message. More... | |
| virtual void | Warning (const char *method, const char *msgfmt,...) const |
| Issue warning message. More... | |
| virtual void | Error (const char *method, const char *msgfmt,...) const |
| Issue error message. More... | |
| virtual void | SysError (const char *method, const char *msgfmt,...) const |
| Issue system error message. More... | |
| virtual void | Fatal (const char *method, const char *msgfmt,...) const |
| Issue fatal error message. More... | |
| void | AbstractMethod (const char *method) const |
| Use this method to implement an "abstract" method that you don't want to leave purely abstract. More... | |
| void | MayNotUse (const char *method) const |
| Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More... | |
| void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
| Use this method to declare a method obsolete. More... | |
Protected Member Functions | |
| Bool_t | LoadHDU (TString &filepath_filter) |
| Load HDU from fits file satisfying the specified filter. More... | |
| void | PrintHDUMetadata (const Option_t *opt="") const |
| Print records. More... | |
| void | PrintFileMetadata (const Option_t *opt="") const |
| Print HDU's parent file's metadata. More... | |
| void | PrintColumnInfo (const Option_t *) const |
| Print column information. More... | |
| void | PrintFullTable (const Option_t *) const |
| Print full table contents. More... | |
Protected Member Functions inherited from TObject | |
| void | MakeZombie () |
| virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
| Interface to ErrorHandler (protected). More... | |
Static Protected Member Functions | |
| static void | CleanFilePath (const char *filepath_with_filter, TString &dst) |
| Clean path from possible filter and put the result in 'dst'. More... | |
Protected Attributes | |
| TString | fFilePath |
| TString | fBaseFilePath |
| struct HDURecord * | fRecords |
| Int_t | fNRecords |
| enum EHDUTypes | fType |
| TString | fExtensionName |
| Int_t | fNumber |
| TArrayI * | fSizes |
| TArrayD * | fPixels |
| struct Column * | fColumnsInfo |
| Int_t | fNColumns |
| Int_t | fNRows |
| union Cell * | fCells |
Protected Attributes inherited from TNamed | |
| TString | fName |
| TString | fTitle |
Private Member Functions | |
| void | _release_resources () |
| Release internal resources. More... | |
| void | _initialize_me () |
| Do some initializations. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
| static Long_t | GetDtorOnly () |
| Return destructor only flag. More... | |
| static void | SetDtorOnly (void *obj) |
| Set destructor only flag. More... | |
| static Bool_t | GetObjectStat () |
| Get status of object stat flag. More... | |
| static void | SetObjectStat (Bool_t stat) |
| Turn on/off tracking of objects in the TObjectTable. More... | |
#include <TFITS.h>
Inheritance diagram for TFITSHDU:
Collaboration diagram for TFITSHDU:| enum TFITSHDU::EHDUTypes |
| TFITSHDU::TFITSHDU | ( | const char * | filepath_with_filter | ) |
TFITSHDU constructor from file path with HDU selection filter.
Please refer to CFITSIO manual for more information about HDU selection filters.
Examples:
TFITSHDU("/path/to/myfile.fits"): just open the PRIMARY HDUTFITSHDU("/path/to/myfile.fits[1]"): open HDU #1TFITSHDU("/path/to/myfile.fits[PICS]"): open HDU called 'PICS'TFITSHDU("/path/to/myfile.fits[ACQ][EXPOSURE > 5]"): open the (table) HDU called 'ACQ' and selects the rows that have column 'EXPOSURE' greater than 5. | TFITSHDU::TFITSHDU | ( | const char * | filepath, |
| Int_t | extension_number | ||
| ) |
| TFITSHDU::TFITSHDU | ( | const char * | filepath, |
| const char * | extension_name | ||
| ) |
|
private |
Do some initializations.
Definition at line 215 of file TFITS.cxx.
Referenced by Change(), and TFITSHDU().
|
private |
Release internal resources.
Definition at line 176 of file TFITS.cxx.
Referenced by Change(), TFITSHDU(), and ~TFITSHDU().
| Bool_t TFITSHDU::Change | ( | const char * | filter | ) |
Change to another HDU given by "filter".
The parameter "filter" will be appended to the FITS file's base path. For example: hduObject.Change("[EVENTS][TIME > 5]"); Please, see documentation of TFITSHDU(const char *filepath_with_filter) constructor for further information.
Definition at line 1275 of file TFITS.cxx.
Referenced by Change(), and GetTabNRows().
Clean path from possible filter and put the result in 'dst'.
Definition at line 93 of file TFITS.cxx.
Referenced by TFITSHDU().
If the HDU is an image, draw the first layer of the primary array To set a title to the canvas, pass it in "opt".
Reimplemented from TObject.
Definition at line 838 of file TFITS.cxx.
Referenced by GetTabNRows().
Get a column from the image HDU when it's a 2D array.
Definition at line 1077 of file TFITS.cxx.
Referenced by GetRecordNumber().
Get a row from the image HDU when it's a 2D array.
Definition at line 1037 of file TFITS.cxx.
Referenced by GetRecordNumber().
Get the name of a column given its index (column>=0).
In case of error the column name is "".
Definition at line 1426 of file TFITS.cxx.
Referenced by GetTabNRows().
| Int_t TFITSHDU::GetColumnNumber | ( | const char * | colname | ) |
Get column number given its name.
Definition at line 1117 of file TFITS.cxx.
Referenced by GetTabNRows(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), and GetTabStringColumn().
| TString & TFITSHDU::GetKeywordValue | ( | const char * | keyword | ) |
Get the value of a given keyword. Return "" if not found.
Definition at line 528 of file TFITS.cxx.
Referenced by GetRecordNumber().
| struct TFITSHDU::HDURecord * TFITSHDU::GetRecord | ( | const char * | keyword | ) |
Get record by keyword.
Definition at line 515 of file TFITS.cxx.
Referenced by GetKeywordValue(), and GetRecordNumber().
Get a real vector embedded in a cell given by (row>=0, column>=0)
Definition at line 1373 of file TFITS.cxx.
Referenced by GetTabNRows(), and GetTabRealVectorCell().
Get a collection of real vectors embedded in cells along a given column from a table HDU. colnum >= 0.
Definition at line 1315 of file TFITS.cxx.
Referenced by GetTabNRows(), and GetTabRealVectorCells().
| TObjArray * TFITSHDU::GetTabRealVectorCells | ( | const char * | colname | ) |
Get a real number-typed column from a table HDU given its column index (>=0).
Definition at line 1194 of file TFITS.cxx.
Referenced by GetTabNRows().
| TVectorD * TFITSHDU::GetTabRealVectorColumn | ( | const char * | colname | ) |
Get a string-typed column from a table HDU given its column index (>=0).
Definition at line 1131 of file TFITS.cxx.
Referenced by GetTabNRows().
| TObjArray * TFITSHDU::GetTabStringColumn | ( | const char * | colname | ) |
Load HDU from fits file satisfying the specified filter.
Returns kTRUE if success. Otherwise kFALSE. If filter == "" then the primary array is selected
Definition at line 230 of file TFITS.cxx.
Referenced by Change(), and TFITSHDU().
Print metadata.
Currently supported options:
Definition at line 722 of file TFITS.cxx.
Referenced by GetRecordNumber().
| TH1 * TFITSHDU::ReadAsHistogram | ( | ) |
Read image HDU as a histogram.
Return 0 if conversion cannot be done. The returned object can be TH1D, TH2D or TH3D depending on data dimensionality. Please, check condition (returnedValue->IsA() == TH*DClass()) to determine the object class.
NOTE: do not confuse with image histogram! This function interprets the array as a histogram. It does not compute the histogram of pixel values of an image! Here "pixels" are interpreted as number of entries.
Definition at line 958 of file TFITS.cxx.
Referenced by GetRecordNumber().
| TImage * TFITSHDU::ReadAsImage | ( | Int_t | layer = 0, |
| TImagePalette * | pal = 0 |
||
| ) |
Read image HDU as a displayable image.
Return 0 if conversion cannot be done. If the HDU seems to be a multilayer image, 'layer' parameter can be used to retrieve the specified layer (starting from 0)
Definition at line 744 of file TFITS.cxx.
Referenced by Draw(), and GetRecordNumber().
Read image HDU as a matrix.
Return 0 if conversion cannot be done If the HDU seems to be a multilayer image, 'layer' parameter can be used to retrieve the specified layer (starting from 0) in matrix form. Options (value of 'opt'): "S": stretch pixel values to a range from 0.0 to 1.0
Definition at line 865 of file TFITS.cxx.
Referenced by GetRecordNumber().
|
protected |
Definition at line 79 of file TFITS.h.
Referenced by Change(), PrintFileMetadata(), and TFITSHDU().
|
protected |
Definition at line 90 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), GetTabStringColumn(), LoadHDU(), and PrintFullTable().
|
protected |
Definition at line 87 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetColumnName(), GetColumnNumber(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), GetTabStringColumn(), LoadHDU(), PrintColumnInfo(), and PrintFullTable().
|
protected |
|
protected |
Definition at line 78 of file TFITS.h.
Referenced by Change(), and TFITSHDU().
|
protected |
Definition at line 88 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetColumnName(), GetColumnNumber(), GetTabNColumns(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), GetTabStringColumn(), LoadHDU(), PrintColumnInfo(), and PrintFullTable().
|
protected |
Definition at line 81 of file TFITS.h.
Referenced by GetRecord(), GetRecordNumber(), LoadHDU(), and PrintHDUMetadata().
|
protected |
Definition at line 89 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetTabNRows(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), GetTabStringColumn(), LoadHDU(), and PrintFullTable().
|
protected |
Definition at line 86 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetArrayColumn(), GetArrayRow(), LoadHDU(), ReadAsHistogram(), ReadAsImage(), and ReadAsMatrix().
|
protected |
Definition at line 80 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), GetRecord(), LoadHDU(), and PrintHDUMetadata().
|
protected |
Definition at line 85 of file TFITS.h.
Referenced by _initialize_me(), _release_resources(), Draw(), GetArrayColumn(), GetArrayRow(), LoadHDU(), ReadAsHistogram(), ReadAsImage(), and ReadAsMatrix().
|
protected |
Definition at line 82 of file TFITS.h.
Referenced by _release_resources(), Draw(), GetArrayColumn(), GetArrayRow(), GetColumnName(), GetTabRealVectorCell(), GetTabRealVectorCells(), GetTabRealVectorColumn(), GetTabStringColumn(), LoadHDU(), PrintColumnInfo(), PrintFullTable(), ReadAsHistogram(), ReadAsImage(), and ReadAsMatrix().