Developer Application Interface (ARC API) v4.5.8
ARC, Inc. GenIV Application Interface
arc::gen4::fits Namespace Reference

Classes

struct  ArrayDeleter
 
struct  fitsParameter_t
 

Typedefs

using BPP_16 = std::uint16_t
 
using BPP_32 = std::uint32_t
 
using keywordValue_t = std::tuple< std::uint32_t, std::int32_t, std::uint64_t, std::int64_t, double, std::string >
 
using point_t = std::pair< long, long >
 

Enumerations

enum class  fitsMode_e : std::int32_t { READMODE = READONLY , READWRITEMODE = READWRITE }
 
enum class  fitsKeyType_e : std::int32_t {
  FITS_INVALID_KEY = -1 , FITS_STRING_KEY = 0 , FITS_INT_KEY , FITS_UINT_KEY ,
  FITS_SHORT_KEY , FITS_USHORT_KEY , FITS_FLOAT_KEY , FITS_DOUBLE_KEY ,
  FITS_BYTE_KEY , FITS_LONG_KEY , FITS_ULONG_KEY , FITS_LONGLONG_KEY ,
  FITS_LOGICAL_KEY , FITS_COMMENT_KEY , FITS_HISTORY_KEY , FITS_DATE_KEY
}
 

Functions

const std::string toString (const fitsParameter_t &tParam)
 
constexpr auto MAKE_POINT (std::uint32_t uiColumn, std::uint32_t uiRow)
 

Typedef Documentation

◆ BPP_16

using arc::gen4::fits::BPP_16 = typedef std::uint16_t

16 bits-per-pixel image data.

Definition at line 52 of file CArcFitsFile.h.

◆ BPP_32

using arc::gen4::fits::BPP_32 = typedef std::uint32_t

32 bits-per-pixel image data.

Definition at line 55 of file CArcFitsFile.h.

◆ keywordValue_t

using arc::gen4::fits::keywordValue_t = typedef std::tuple<std::uint32_t, std::int32_t, std::uint64_t, std::int64_t, double, std::string>

Keyword return type. If std::variant is supported, then one of the variant values will be returned. If only std::tuple is supported, then only one of the tuple values will contain valid data.

Definition at line 63 of file CArcFitsFile.h.

◆ point_t

using arc::gen4::fits::point_t = typedef std::pair<long, long>

Point parameter type definition

Parameters
firstParam- The x value
secondParam- The y value

Definition at line 152 of file CArcFitsFile.h.

Enumeration Type Documentation

◆ fitsMode_e

enum class arc::gen4::fits::fitsMode_e : std::int32_t
strong
Enumerator
READMODE 

Create or open the FITS file in read only mode.

READWRITEMODE 

Create or open the FITS file in read-write mode.

Definition at line 74 of file CArcFitsFile.h.

◆ fitsKeyType_e

enum class arc::gen4::fits::fitsKeyType_e : std::int32_t
strong
Enumerator
FITS_INVALID_KEY 

Invalid key type

FITS_STRING_KEY 

String key type

FITS_INT_KEY 

Integer key type

FITS_UINT_KEY 

Unsigned integer key type

FITS_SHORT_KEY 

Short key type

FITS_USHORT_KEY 

Unsigned short key type

FITS_FLOAT_KEY 

Float key type

FITS_DOUBLE_KEY 

Double key type

FITS_BYTE_KEY 

Byte key type

FITS_LONG_KEY 

Long key type

FITS_ULONG_KEY 

Unsigned long key type

FITS_LONGLONG_KEY 

Long long key type

FITS_LOGICAL_KEY 

Boolean key type

FITS_COMMENT_KEY 

String key type

FITS_HISTORY_KEY 

String key type

FITS_DATE_KEY 

String key type

Definition at line 84 of file CArcFitsFile.h.

Function Documentation

◆ toString()

const std::string arc::gen4::fits::toString ( const fitsParameter_t tParam)

Image parameters info helper funciton to stringify member names and values.

Parameters
tParam- The arc::gen4::fits::fitsParameter_t to convert to a string.

◆ MAKE_POINT()

constexpr auto arc::gen4::fits::MAKE_POINT ( std::uint32_t  uiColumn,
std::uint32_t  uiRow 
)
constexpr

Macro to create a point parameter.

Parameters
uiColumn- The point column.
uiRow- The point row.

Definition at line 159 of file CArcFitsFile.h.