XISF-specific file options More...

#include <XISF.h>

Public Member Functions
	XISFOptions ()

	XISFOptions (const XISFOptions &)=default

XISFOptions &	operator= (const XISFOptions &)=default

void	Reset ()

Public Attributes
bool	autoMetadata: 1
	Automatically generate a number of reserved XISF properties.

uint16	blockAlignmentSize
	Block alignment size in bytes (0 = 1 = unaligned).

XISF::block_checksum	checksumAlgorithm: 4
	The algorithm used for block checksum calculations.

XISF::block_compression	compressionCodec: 5
	The codec used for compression of XISF blocks.

uint8	compressionLevel: 7
	Codec-independent compression level: 0 = auto, 1 = fast, 100 = maximum compression.

bool	fixNonFinite: 1
	Replace NaNs, infinities and negative zeros with lower bound values in floating point images (reading only).

bool	ignoreEmbeddedData: 1
	Do not load existing embedded data (such as ICC profiles for example).

bool	ignoreFITSKeywords: 1
	Do not load FITS keywords from input XISF files.

bool	ignoreProperties: 1
	Do not load existing XISF properties.

bool	importFITSKeywords: 1
	Import FITS keywords as XISF properties.

uint16	maxInlineBlockSize
	Maximum size in bytes of an inline/embedded block.

bool	noWarnings: 1
	Suppress all warning and diagnostics messages.

double	outputLowerBound
	Lower bound for output floating point pixel samples (=0.0 by default).

double	outputUpperBound
	Upper bound for output floating point pixel samples (=1.0 by default).

bool	storeFITSKeywords: 1
	Include FITS header keywords in output XISF files.

uint8	verbosity: 3
	Verbosity level: 0 = quiet, > 0 = write console state messages.

bool	warningsAreErrors: 1
	Treat warnings as fatal errors.

Detailed Description

This structure stores a collection of settings and options that control the way XISF units are loaded and generated by this implementation.

XISFOptions, along with ImageOptions, allow client modules and applications to manipulate properties and images serialized in XISF units with a high degree of flexibility, tailoring them to the needs of each application.

Definition at line 636 of file XISF.h.

Constructor & Destructor Documentation

◆ XISFOptions() [1/2]

pcl::XISFOptions::XISFOptions ( )

inline

Constructs a default set of XISF format-specific options.

Definition at line 661 of file XISF.h.

◆ XISFOptions() [2/2]

pcl::XISFOptions::XISFOptions ( const XISFOptions & )

default

Copy constructor.

Member Function Documentation

◆ operator=()

XISFOptions& pcl::XISFOptions::operator= ( const XISFOptions & )

default

Copy-assignment operator. Returns a reference to this object.

◆ Reset()

void pcl::XISFOptions::Reset ( )

inline

Resets this object to a default set of format-specific options.

Definition at line 679 of file XISF.h.

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

XISF.h

Public Member Functions