Logo ROOT  
Reference Guide
TFITSHDU Class Reference

FITS file interface class.

TFITSHDU is a class that allows extracting images and data from FITS files and contains several methods to manage them.

Definition at line 35 of file TFITS.h.

Classes

union  Cell
 
struct  Column
 
struct  HDURecord
 

Public Types

enum  EColumnTypes { kString , kRealNumber , kRealArray , kRealVector }
 
enum  EHDUTypes { kImageHDU , kTableHDU }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 

Public Member Functions

 TFITSHDU (const char *filepath, const char *extension_name)
 TFITSHDU constructor from filepath and extension name. More...
 
 TFITSHDU (const char *filepath, Int_t extension_number)
 TFITSHDU constructor from filepath and extension number. More...
 
 TFITSHDU (const char *filepath_with_filter)
 TFITSHDU constructor from file path with HDU selection filter. More...
 
 ~TFITSHDU ()
 TFITSHDU destructor. 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...
 
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...
 
TVectorDGetArrayColumn (UInt_t col)
 Get a column from the image HDU when it's a 2D array. More...
 
TVectorDGetArrayRow (UInt_t row)
 Get a row from the image HDU when it's a 2D array. More...
 
const TStringGetColumnName (Int_t colnum)
 Get the name of a column given its index (column>=0). More...
 
Int_t GetColumnNumber (const char *colname)
 Get column number given its name. More...
 
TStringGetKeywordValue (const char *keyword)
 Get the value of a given keyword. Return "" if not found. More...
 
struct HDURecordGetRecord (const char *keyword)
 Get record by keyword. More...
 
Int_t GetRecordNumber () const
 
Int_t GetTabNColumns () const
 
Int_t GetTabNRows () const
 
TVectorDGetTabRealVectorCell (Int_t rownum, const char *colname)
 Get a real vector embedded in a cell given by (row>=0, column name) More...
 
TVectorDGetTabRealVectorCell (Int_t rownum, Int_t colnum)
 Get a real array (with fixed or variable-length) embedded in a cell given by (row>=0, column>=0) More...
 
TObjArrayGetTabRealVectorCells (const char *colname)
 Get a collection of real vectors embedded in cells along a given column from a table HDU by name. More...
 
TObjArrayGetTabRealVectorCells (Int_t colnum)
 Get a collection of real vectors embedded in cells along a given column from a table HDU. colnum >= 0. More...
 
TVectorDGetTabRealVectorColumn (const char *colname)
 Get a real number-typed column from a table HDU given its name. More...
 
TVectorDGetTabRealVectorColumn (Int_t colnum)
 Get a real number-typed column from a table HDU given its column index (>=0). More...
 
TObjArrayGetTabStringColumn (const char *colname)
 Get a string-typed column from a table HDU given its name. More...
 
TObjArrayGetTabStringColumn (Int_t colnum)
 Get a string-typed column from a table HDU given its column index (>=0). More...
 
TArrayDGetTabVarLengthVectorCell (Int_t rownum, const char *colname)
 Get the variable-length array contained in a cell given by (row>=0, column name) More...
 
TArrayDGetTabVarLengthVectorCell (Int_t rownum, Int_t colnum)
 Get the variable-length array contained in a cell given by (row>=0, column name) More...
 
void Print (const Option_t *opt="") const
 Print metadata. More...
 
TH1ReadAsHistogram ()
 Read image HDU as a histogram. More...
 
TImageReadAsImage (Int_t layer=0, TImagePalette *pal=0)
 Read image HDU as a displayable image. More...
 
TMatrixDReadAsMatrix (Int_t layer=0, Option_t *opt="")
 Read image HDU as a matrix. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (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 ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. 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...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
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 void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

Bool_t LoadHDU (TString &filepath_filter)
 Load HDU from fits file satisfying the specified filter. More...
 
void PrintColumnInfo (const Option_t *) const
 Print column information. More...
 
void PrintFileMetadata (const Option_t *opt="") const
 Print HDU's parent file's metadata. More...
 
void PrintFullTable (const Option_t *) const
 Print full table contents. More...
 
void PrintHDUMetadata (const Option_t *opt="") const
 Print records. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

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 fBaseFilePath
 Path to HDU's file excluding filter. More...
 
union CellfCells
 Table cells (when fType == kTableHDU). More...
 
struct ColumnfColumnsInfo
 Information about columns (when fType == kTableHDU) More...
 
TString fExtensionName
 Extension Name. More...
 
TString fFilePath
 Path to HDU's file including filter. More...
 
Int_t fNColumns
 Number of columns (when fType == kTableHDU) More...
 
Int_t fNRecords
 Number of records. More...
 
Int_t fNRows
 Number of rows (when fType == kTableHDU) More...
 
Int_t fNumber
 HDU number (1=PRIMARY) More...
 
TArrayDfPixels
 Image pixels (when fType == kImageHDU) More...
 
struct HDURecordfRecords
 HDU metadata records. More...
 
TArrayIfSizes
 Image sizes in each dimension (when fType == kImageHDU) More...
 
enum EHDUTypes fType
 HDU type. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Member Functions

void _initialize_me ()
 Do some initializations. More...
 
void _release_resources ()
 Release internal resources. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 

#include <TFITS.h>

Inheritance diagram for TFITSHDU:
[legend]

Member Enumeration Documentation

◆ EColumnTypes

Enumerator
kString 
kRealNumber 
kRealArray 
kRealVector 

Definition at line 47 of file TFITS.h.

◆ EHDUTypes

Enumerator
kImageHDU 
kTableHDU 

Definition at line 42 of file TFITS.h.

Constructor & Destructor Documentation

◆ TFITSHDU() [1/3]

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 HDU
  • TFITSHDU("/path/to/myfile.fits[1]"): open HDU #1
  • TFITSHDU("/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.

Definition at line 118 of file TFITS.cxx.

◆ TFITSHDU() [2/3]

TFITSHDU::TFITSHDU ( const char *  filepath,
Int_t  extension_number 
)

TFITSHDU constructor from filepath and extension number.

Definition at line 134 of file TFITS.cxx.

◆ TFITSHDU() [3/3]

TFITSHDU::TFITSHDU ( const char *  filepath,
const char *  extension_name 
)

TFITSHDU constructor from filepath and extension name.

Definition at line 151 of file TFITS.cxx.

◆ ~TFITSHDU()

TFITSHDU::~TFITSHDU ( )

TFITSHDU destructor.

Definition at line 169 of file TFITS.cxx.

Member Function Documentation

◆ _initialize_me()

void TFITSHDU::_initialize_me ( )
private

Do some initializations.

Definition at line 222 of file TFITS.cxx.

◆ _release_resources()

void TFITSHDU::_release_resources ( )
private

Release internal resources.

Definition at line 177 of file TFITS.cxx.

◆ Change() [1/2]

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 1414 of file TFITS.cxx.

◆ Change() [2/2]

Bool_t TFITSHDU::Change ( Int_t  extension_number)

Change to another HDU given by extension_number.

Definition at line 1443 of file TFITS.cxx.

◆ CleanFilePath()

void TFITSHDU::CleanFilePath ( const char *  filepath_with_filter,
TString dst 
)
staticprotected

Clean path from possible filter and put the result in 'dst'.

Definition at line 94 of file TFITS.cxx.

◆ Draw()

void TFITSHDU::Draw ( Option_t opt = "")
virtual

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 973 of file TFITS.cxx.

◆ GetArrayColumn()

TVectorD * TFITSHDU::GetArrayColumn ( UInt_t  col)

Get a column from the image HDU when it's a 2D array.

Definition at line 1212 of file TFITS.cxx.

◆ GetArrayRow()

TVectorD * TFITSHDU::GetArrayRow ( UInt_t  row)

Get a row from the image HDU when it's a 2D array.

Definition at line 1172 of file TFITS.cxx.

◆ GetColumnName()

const TString & TFITSHDU::GetColumnName ( Int_t  colnum)

Get the name of a column given its index (column>=0).

In case of error the column name is "".

Definition at line 1565 of file TFITS.cxx.

◆ GetColumnNumber()

Int_t TFITSHDU::GetColumnNumber ( const char *  colname)

Get column number given its name.

Definition at line 1252 of file TFITS.cxx.

◆ GetKeywordValue()

TString & TFITSHDU::GetKeywordValue ( const char *  keyword)

Get the value of a given keyword. Return "" if not found.

Definition at line 638 of file TFITS.cxx.

◆ GetRecord()

struct TFITSHDU::HDURecord * TFITSHDU::GetRecord ( const char *  keyword)

Get record by keyword.

Definition at line 625 of file TFITS.cxx.

◆ GetRecordNumber()

Int_t TFITSHDU::GetRecordNumber ( ) const
inline

Definition at line 111 of file TFITS.h.

◆ GetTabNColumns()

Int_t TFITSHDU::GetTabNColumns ( ) const
inline

Definition at line 124 of file TFITS.h.

◆ GetTabNRows()

Int_t TFITSHDU::GetTabNRows ( ) const
inline

Definition at line 125 of file TFITS.h.

◆ GetTabRealVectorCell() [1/2]

TVectorD * TFITSHDU::GetTabRealVectorCell ( Int_t  rownum,
const char *  colname 
)

Get a real vector embedded in a cell given by (row>=0, column name)

Definition at line 1544 of file TFITS.cxx.

◆ GetTabRealVectorCell() [2/2]

TVectorD * TFITSHDU::GetTabRealVectorCell ( Int_t  rownum,
Int_t  colnum 
)

Get a real array (with fixed or variable-length) embedded in a cell given by (row>=0, column>=0)

Definition at line 1513 of file TFITS.cxx.

◆ GetTabRealVectorCells() [1/2]

TObjArray * TFITSHDU::GetTabRealVectorCells ( const char *  colname)

Get a collection of real vectors embedded in cells along a given column from a table HDU by name.

Definition at line 1493 of file TFITS.cxx.

◆ GetTabRealVectorCells() [2/2]

TObjArray * TFITSHDU::GetTabRealVectorCells ( Int_t  colnum)

Get a collection of real vectors embedded in cells along a given column from a table HDU. colnum >= 0.

Definition at line 1454 of file TFITS.cxx.

◆ GetTabRealVectorColumn() [1/2]

TVectorD * TFITSHDU::GetTabRealVectorColumn ( const char *  colname)

Get a real number-typed column from a table HDU given its name.

Definition at line 1368 of file TFITS.cxx.

◆ GetTabRealVectorColumn() [2/2]

TVectorD * TFITSHDU::GetTabRealVectorColumn ( Int_t  colnum)

Get a real number-typed column from a table HDU given its column index (>=0).

Definition at line 1329 of file TFITS.cxx.

◆ GetTabStringColumn() [1/2]

TObjArray * TFITSHDU::GetTabStringColumn ( const char *  colname)

Get a string-typed column from a table HDU given its name.

Definition at line 1296 of file TFITS.cxx.

◆ GetTabStringColumn() [2/2]

TObjArray * TFITSHDU::GetTabStringColumn ( Int_t  colnum)

Get a string-typed column from a table HDU given its column index (>=0).

Definition at line 1266 of file TFITS.cxx.

◆ GetTabVarLengthVectorCell() [1/2]

TArrayD * TFITSHDU::GetTabVarLengthVectorCell ( Int_t  rownum,
const char *  colname 
)

Get the variable-length array contained in a cell given by (row>=0, column name)

Definition at line 1606 of file TFITS.cxx.

◆ GetTabVarLengthVectorCell() [2/2]

TArrayD * TFITSHDU::GetTabVarLengthVectorCell ( Int_t  rownum,
Int_t  colnum 
)

Get the variable-length array contained in a cell given by (row>=0, column name)

Definition at line 1583 of file TFITS.cxx.

◆ LoadHDU()

Bool_t TFITSHDU::LoadHDU ( TString filepath_filter)
protected

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 237 of file TFITS.cxx.

◆ Print()

void TFITSHDU::Print ( const Option_t opt = "") const

Print metadata.

Currently supported options:

  • "" : print HDU record data
  • "F" : print FITS file's extension names, numbers and types
  • "F+": print FITS file's extension names and types and their record data
  • "T" : print column information when HDU is a table
  • "T+" : print full table (columns header and rows)

Definition at line 858 of file TFITS.cxx.

◆ PrintColumnInfo()

void TFITSHDU::PrintColumnInfo ( const Option_t ) const
protected

Print column information.

Definition at line 766 of file TFITS.cxx.

◆ PrintFileMetadata()

void TFITSHDU::PrintFileMetadata ( const Option_t opt = "") const
protected

Print HDU's parent file's metadata.

Definition at line 665 of file TFITS.cxx.

◆ PrintFullTable()

void TFITSHDU::PrintFullTable ( const Option_t ) const
protected

Print full table contents.

Definition at line 794 of file TFITS.cxx.

◆ PrintHDUMetadata()

void TFITSHDU::PrintHDUMetadata ( const Option_t opt = "") const
protected

Print records.

Definition at line 651 of file TFITS.cxx.

◆ ReadAsHistogram()

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 1093 of file TFITS.cxx.

◆ ReadAsImage()

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 880 of file TFITS.cxx.

◆ ReadAsMatrix()

TMatrixD * TFITSHDU::ReadAsMatrix ( Int_t  layer = 0,
Option_t opt = "" 
)

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 1000 of file TFITS.cxx.

Member Data Documentation

◆ fBaseFilePath

TString TFITSHDU::fBaseFilePath
protected

Path to HDU's file excluding filter.

Definition at line 79 of file TFITS.h.

◆ fCells

union Cell* TFITSHDU::fCells
protected

Table cells (when fType == kTableHDU).

Cells are ordered in the following way: fCells[0..fNRows-1] -> cells of column 0 fCells[fNRows..2*fNRows-1] -> cells of column 1 fCells[2*fNRows..3*fNRows-1] -> cells of column 2 fCells[(fNColumns-1)*fNRows..fNColumns*fNRows-1] -> cells of column fNColumns-1

Definition at line 90 of file TFITS.h.

◆ fColumnsInfo

struct Column* TFITSHDU::fColumnsInfo
protected

Information about columns (when fType == kTableHDU)

Definition at line 87 of file TFITS.h.

◆ fExtensionName

TString TFITSHDU::fExtensionName
protected

Extension Name.

Definition at line 83 of file TFITS.h.

◆ fFilePath

TString TFITSHDU::fFilePath
protected

Path to HDU's file including filter.

Definition at line 78 of file TFITS.h.

◆ fNColumns

Int_t TFITSHDU::fNColumns
protected

Number of columns (when fType == kTableHDU)

Definition at line 88 of file TFITS.h.

◆ fNRecords

Int_t TFITSHDU::fNRecords
protected

Number of records.

Definition at line 81 of file TFITS.h.

◆ fNRows

Int_t TFITSHDU::fNRows
protected

Number of rows (when fType == kTableHDU)

Definition at line 89 of file TFITS.h.

◆ fNumber

Int_t TFITSHDU::fNumber
protected

HDU number (1=PRIMARY)

Definition at line 84 of file TFITS.h.

◆ fPixels

TArrayD* TFITSHDU::fPixels
protected

Image pixels (when fType == kImageHDU)

Definition at line 86 of file TFITS.h.

◆ fRecords

struct HDURecord* TFITSHDU::fRecords
protected

HDU metadata records.

Definition at line 80 of file TFITS.h.

◆ fSizes

TArrayI* TFITSHDU::fSizes
protected

Image sizes in each dimension (when fType == kImageHDU)

Definition at line 85 of file TFITS.h.

◆ fType

enum EHDUTypes TFITSHDU::fType
protected

HDU type.

Definition at line 82 of file TFITS.h.

Libraries for TFITSHDU:
[legend]

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