ngcbFITS Class Reference

#include <ngcbFITS.hpp>

Public Member Functions
	ngcbFITS ()
	Constructor.
	ngcbFITS (int n)
	Constructor with number of blocks to reserve.
virtual	~ngcbFITS ()
	Destructor.
int	NumBlock (int n)
	Number of blocks to reserve.
int	NumBlock ()
	Actual number of reserved blocks.
char *	Header ()
	Current header.
int	HeaderSize ()
	Current header size.
void	HeaderSize (int s)
	Import header size.
void	HeaderInit ()
	(Re-)initialize header
void	HeaderEnd ()
	Finish header (padding etc.)
int	GetKey (const char *fitsLine, char *keyword, char *value=NULL)
	Get keyword and value from line.
int	Full ()
	Check if header is full.
int	Read (const char *keyword, int *offset, char *value=NULL)
	Read keyword and value from header.
int	Write (const char *fitsLine)
	(Re-)Write a line in the header
int	Append (const char *fitsLine)
	Append a line to the header.
int	Add (const char *keyword, int var, const char *comment=NULL)
	Add 32-bit integer keyword.
int	Add (const char *keyword, float var, const char *comment=NULL)
	Add 32-bit floating point keyword.
int	Add (const char *keyword, double var, const char *comment=NULL)
	Add 64-bit floating point keyword.
int	Add (const char *keyword, const char *var, const char *comment=NULL)
	Add string keyword.
int	AddLongString (const char *keyword, const char *var, const char *comment=NULL)
	Add long string keyword.
int	Add (const char *comment)
	Add comment.
int	AddLogical (const char *keyword, int var, const char *comment=NULL)
	Add logical keyword.
int	AddFree (const char *keyword, const char *var, const char *comment=NULL)
	Add free generic keyword.
int	Merge (const char *keyword, int var, const char *comment=NULL)
	Merge 32-bit integer keyword (overwrite if existing)
int	Merge (const char *keyword, float var, const char *comment=NULL)
	Merge 32-bit floating point keyword (overwrite if existing)
int	Merge (const char *keyword, double var, const char *comment=NULL)
	Merge 64-bit floating point keyword (overwrite if existing)
int	Merge (const char *keyword, const char *var, const char *comment=NULL)
	Merge string keyword (overwrite if existing)
int	Merge (const char *keyword, const char *comment=NULL)
	Merge comment (overwrite if existing)
int	MergeFree (const char *keyword, const char *var, const char *comment=NULL)
	Merge free generic keyword (overwrite if existing)
int	Merge (ngcbFITS *object)
	Merge two instances.
void	AttachDictionary (ngcbDIC *dic)
	Attach dictionary.
void	DetachDictionary ()
	Detach dictionary.
char *	ErrMsg ()
	Error message.

Public Attributes
char	padBlock [ngcbFITS_BLOCK_LEN]
	Constant block for padding.

Detailed Description

NGC FITS-file class

Constructor & Destructor Documentation

ngcbFITS() [1/2]

ngcbFITS::ngcbFITS

(

)

Constructor.

ngcbFITS() [2/2]

ngcbFITS::ngcbFITS ( int n )

explicit

Constructor with number of blocks to reserve.

~ngcbFITS()

ngcbFITS::~ngcbFITS ( )

virtual

Destructor.

Member Function Documentation

Add() [1/5]

int ngcbFITS::Add

(

const char *

comment

)

Add comment.

Add() [2/5]

int ngcbFITS::Add	(	const char *	keyword,
		const char *	var,
		const char *	comment = NULL )

Add string keyword.

Add() [3/5]

int ngcbFITS::Add	(	const char *	keyword,
		double	var,
		const char *	comment = NULL )

Add 64-bit floating point keyword.

Add() [4/5]

int ngcbFITS::Add	(	const char *	keyword,
		float	var,
		const char *	comment = NULL )

Add 32-bit floating point keyword.

Add() [5/5]

int ngcbFITS::Add	(	const char *	keyword,
		int	var,
		const char *	comment = NULL )

Add 32-bit integer keyword.

AddFree()

int ngcbFITS::AddFree	(	const char *	keyword,
		const char *	var,
		const char *	comment = NULL )

Add free generic keyword.

AddLogical()

int ngcbFITS::AddLogical	(	const char *	keyword,
		int	var,
		const char *	comment = NULL )

Add logical keyword.

AddLongString()

int ngcbFITS::AddLongString	(	const char *	keyword,
		const char *	var,
		const char *	comment = NULL )

Add long string keyword.

Append()

int ngcbFITS::Append

(

const char *

fitsLine

)

Append a line to the header.

AttachDictionary()

void ngcbFITS::AttachDictionary

(

ngcbDIC *

dic

)

Attach dictionary.

DetachDictionary()

void ngcbFITS::DetachDictionary

(

)

Detach dictionary.

ErrMsg()

char * ngcbFITS::ErrMsg ( )

inline

Error message.

Full()

int ngcbFITS::Full ( )

inline

Check if header is full.

GetKey()

int ngcbFITS::GetKey	(	const char *	fitsLine,
		char *	keyword,
		char *	value = NULL )

Get keyword and value from line.

Header()

char * ngcbFITS::Header ( )

inline

Current header.

HeaderEnd()

void ngcbFITS::HeaderEnd

(

)

Finish header (padding etc.)

HeaderInit()

void ngcbFITS::HeaderInit

(

)

(Re-)initialize header

HeaderSize() [1/2]

int ngcbFITS::HeaderSize ( )

inline

Current header size.

HeaderSize() [2/2]

void ngcbFITS::HeaderSize ( int s )

inline

Import header size.

Merge() [1/6]

int ngcbFITS::Merge	(	const char *	keyword,
		const char *	comment = NULL )

Merge comment (overwrite if existing)

Merge() [2/6]

int ngcbFITS::Merge	(	const char *	keyword,
		const char *	var,
		const char *	comment = NULL )

Merge string keyword (overwrite if existing)

Merge() [3/6]

int ngcbFITS::Merge	(	const char *	keyword,
		double	var,
		const char *	comment = NULL )

Merge 64-bit floating point keyword (overwrite if existing)

Merge() [4/6]

int ngcbFITS::Merge	(	const char *	keyword,
		float	var,
		const char *	comment = NULL )

Merge 32-bit floating point keyword (overwrite if existing)

Merge() [5/6]

int ngcbFITS::Merge	(	const char *	keyword,
		int	var,
		const char *	comment = NULL )

Merge 32-bit integer keyword (overwrite if existing)

Merge() [6/6]

int ngcbFITS::Merge

(

ngcbFITS *

object

)

Merge two instances.

MergeFree()

int ngcbFITS::MergeFree	(	const char *	keyword,
		const char *	var,
		const char *	comment = NULL )

Merge free generic keyword (overwrite if existing)

NumBlock() [1/2]

int ngcbFITS::NumBlock

(

)

Actual number of reserved blocks.

NumBlock() [2/2]

int ngcbFITS::NumBlock

(

int

n

)

Number of blocks to reserve.

Read()

int ngcbFITS::Read	(	const char *	keyword,
		int *	offset,
		char *	value = NULL )

Read keyword and value from header.

Write()

int ngcbFITS::Write

(

const char *

fitsLine

)

(Re-)Write a line in the header

Member Data Documentation

padBlock

char ngcbFITS::padBlock[ngcbFITS_BLOCK_LEN]

Constant block for padding.

---

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

• core/ngcbCORE/src/include/ngc/core/ngcbFITS.hpp
• core/ngcbCORE/src/ngcbFITS.cpp