TIFFEXT Class Reference
Base class for TIFF image access. More...
#include <mi32/tiffext.h>
Detailed Description
Base class for TIFF image access.
Container for information about specific TIFF image.
Member Enumeration Documentation
| enum TIFFEXT::COMPRESSION |
- Enumerator:
enum TIFFEXT::OPENMODE [protected] |
| enum TIFFEXT::PHOTOMETRIC |
Constructor & Destructor Documentation
| TIFFEXT::TIFFEXT | ( | ) | [protected] |
Constructor.
| virtual TIFFEXT::~TIFFEXT | ( | ) | [protected, virtual] |
Destructor.
| TIFFEXT::~IMAGEINFO | ( | ) |
Destructor.
Member Function Documentation
| void TIFFEXT::AddRef | ( | ) |
Increment reference count.
Reference count will be 1 after construction, only use if require reference counting.
| ERRVALUE TIFFEXT::CloseTIFF | ( | ) | [protected] |
Close TIFF instance.
| UINT16 TIFFEXT::GetBitsPerSample | ( | ) | const |
Get number of bits per sample.
Although the TIFF spec allows a different number of bits for each sample, the libtiff implementation does not, so at present all samples must have the same number of bits.
| COMPRESSION TIFFEXT::GetCompression | ( | ) | const |
Get compression method.
| int TIFFEXT::GetDefaultImageIdx | ( | ) | const |
Get index of 'default' image.
| MISTRING TIFFEXT::GetDescription | ( | ) | const |
Get image description.
| IMAGEINFO TIFFEXT::GetImageInfo | ( | ) | const |
Get information about currently opened image.
| INT32 TIFFEXT::GetImageLength | ( | ) | const |
Get image length (number of lines).
| INT32 TIFFEXT::GetImageWidth | ( | ) | const |
Get image width (number of columns).
| int TIFFEXT::GetNumImages | ( | ) | const |
Get number of images in file.
| int TIFFEXT::GetOpenImageIdx | ( | ) | const |
Get index of currently opened image.
| PHOTOMETRIC TIFFEXT::GetPhotometric | ( | ) | const |
Get photometric intepretation.
| PLANARCONFIG TIFFEXT::GetPlanarConfig | ( | ) | const |
Get planar configuration.
- Returns:
- PLANARCONFIG_Contiguous (pixel-interleaved) or PLANARCONFIG_Separate (band sequential)
| SAMPLEFORMAT TIFFEXT::GetSampleFormat | ( | ) | const |
Get sample numeric format.
Although the TIFF spec allows a different numeric format for each sample, the libtiff implementation does not, so at present all samples must have the same numeric format.
Get 'name' of sample.
- Returns:
- String, guaranteed not to be empty for valid sample index.
- Parameters:
-
sample Sample index
| UINT16 TIFFEXT::GetSamplesPerPixel | ( | ) | const |
Get number of samples per pixel.
| INT32 TIFFEXT::GetSegmentLength | ( | ) | const |
Get segment (tile or strip) length (number of lines).
| INT32 TIFFEXT::GetSegmentWidth | ( | ) | const |
Get segment (tile or strip) width (number of columns).
| SUBTYPEFLAGS TIFFEXT::GetSubTypeFlags | ( | ) | const |
Get subtype flags.
| TIFFEXT::IMAGEINFO | ( | const IMAGEINFO & | rhs | ) |
Copy constructor.
| TIFFEXT::IMAGEINFO | ( | INT32 | ImageLength, | |
| INT32 | ImageWidth, | |||
| UINT16 | SamplesPerPixel, | |||
| UINT16 | BitsPerSample, | |||
| SAMPLEFORMAT | SampleFormat = SAMPLEFORMAT_Unsigned | |||
| ) |
Constructor for setting up new info.
- Parameters:
-
ImageLength Image length (number of lines) ImageWidth Image width (number of columns) SamplesPerPixel Number of samples (components) per pixel BitsPerSample Number of bits per sample, same for all samples SampleFormat Sample numeric format
| bool TIFFEXT::IsTiled | ( | ) | const |
Determine if image is 'tiled'.
| int TIFFEXT::MakeImage | ( | const IMAGEINFO & | imageinfo | ) |
Make and open new image.
- Returns:
- New image index or error < 0.
- Parameters:
-
imageinfo Settings for image to create
Open specified image.
If file is opened for reading the first image is opened by default.
| ERRVALUE TIFFEXT::OpenTIFF | ( | GENERICRW * | pGenRW, | |
| const MIUNICODE * | name, | |||
| OPENMODE | openmode, | |||
| bool | IsBigTiff = false | |||
| ) | [protected] |
Open TIFF instance.
- Parameters:
-
pGenRW Read/write class instance, must support seeking name "Name" of file or instance openmode OPENMODE_Read or OPENMODE_Write,
| IMAGEINFO& TIFFEXT::operator= | ( | const IMAGEINFO & | rhs | ) |
Assignment operator.
| int TIFFEXT::ReadContrastTable | ( | SIMPLE_ARRAY< UINT8 > & | table | ) |
Read contrast table.
- Returns:
- TRUE if has table, FALSE if not, < 0 if error.
- Parameters:
-
table Contrast table returned
| int TIFFEXT::ReadGeoreference | ( | SPATREF::COORDREFSYS & | CoordRefSys, | |
| TRANS2D_AFFINE & | TransAffine, | |||
| SIMPLE_ARRAY< CTRLPOINT3 > & | CtrlPoints | |||
| ) |
Read georeference information.
- Returns:
- TRUE if has georeference, FALSE if not, < 0 if error.
- Parameters:
-
CoordRefSys Coordinate Reference System definition returned TransAffine Affine transformation returned CtrlPoints Control point array returned, empty if no control points
| int TIFFEXT::ReadPalette | ( | COLOR_ARRAY & | palette | ) |
Read color palette.
- Returns:
- TRUE if has table, FALSE if not, < 0 if error.
- Parameters:
-
palette Color palette returned
| ERRVALUE TIFFEXT::ReadPixels | ( | INT32 | sample, | |
| INT32 | line, | |||
| INT32 | column, | |||
| INT32 | numpixels, | |||
| void * | buffer, | |||
| bool | leavepacked = false | |||
| ) |
Read all or part of a line of pixels from image.
- Parameters:
-
sample Sample index, -1 for all samples if PLANARCONFIG_Contiguous line Starting line column Starting column numpixels Number of pixels to read buffer Buffer to contain pixels leavepacked Leave buffer packed if < 8 bits per sample
| bool TIFFEXT::Release | ( | ) |
Decrement reference count and destroy if no more references.
- Returns:
- 'true' if instance was deleted, false if not.
| void TIFFEXT::SetCompression | ( | COMPRESSION | compression | ) |
Set compression type.
| void TIFFEXT::SetDescription | ( | const MISTRING & | desc | ) |
Set image description.
| void TIFFEXT::SetPhotometric | ( | PHOTOMETRIC | photometric | ) |
Set photometric interpretation.
| void TIFFEXT::SetPlanarConfig | ( | PLANARCONFIG | PlanarConfig | ) |
Set planar configuration.
| void TIFFEXT::SetResolution | ( | double | xres, | |
| double | yres, | |||
| RESOLUTIONUNIT | resunit | |||
| ) |
Set resolution.
Set segment size.
Actual segment size may be adjusted based on format requirements. Adjusted size may be retrieved via GetSegmentHeight/Width.
| void TIFFEXT::SetSubTypeFlags | ( | SUBTYPEFLAGS | SubTypeFlags | ) |
Set image subtype flags.
| void TIFFEXT::SetWriteUserDefinedCRS | ( | bool | WriteUserDefinedCRS = true |
) |
Set to write user-defined Coordinate Reference System when writing georeference.
This may improve compatibility with some GeoTIFF readers.
Set to write the Maximum and Minimum cell values to HALFTONEHINTS Used for linear contrast stretching.
- Parameters:
-
MaxValue Maximum Cell Value MinValue Minimum Cell Value
| ERRVALUE TIFFEXT::WriteGeoreference | ( | const SPATREF::COORDREFSYS & | CoordRefSys, | |
| const SIMPLE_ARRAY< CTRLPOINT3 > & | CtrlPoints, | |||
| bool | ForceNonRotated = false | |||
| ) |
Write georeference information using control point array.
- Parameters:
-
CoordRefSys Coordinate Reference System definition
| ERRVALUE TIFFEXT::WriteGeoreference | ( | const SPATREF::COORDREFSYS & | CoordRefSys, | |
| const CTRLPOINT3 * | CtrlPoints, | |||
| int | NumCtrlPoints, | |||
| bool | ForceNonRotated = false | |||
| ) |
Write georeference information using control point array.
- Parameters:
-
CoordRefSys Coordinate Reference System definition
| ERRVALUE TIFFEXT::WriteGeoreference | ( | const SPATREF::COORDREFSYS & | CoordRefSys, | |
| const TRANS2D_AFFINE & | TransAffine, | |||
| bool | ForceNonRotated = false | |||
| ) |
Write georeference information using TRANS2D_AFFINE.
- Parameters:
-
CoordRefSys Coordinate Reference System definition
| ERRVALUE TIFFEXT::WritePalette | ( | const COLOR_ARRAY & | palette | ) |
Write color palette.
| ERRVALUE TIFFEXT::WritePixels | ( | INT32 | sample, | |
| INT32 | line, | |||
| INT32 | column, | |||
| INT32 | numpixels, | |||
| const void * | buffer, | |||
| bool | prepacked = false | |||
| ) |
Write all or part of a line of pixels from image.
- Parameters:
-
sample Sample index, -1 for all samples if PLANARCONFIG_Contiguous line Starting line column Starting column numpixels Number of pixels to read buffer Buffer containing pixels to write prepacked Is buffer pre-packed for data less than 8 bits per sample
The documentation for this class was generated from the following file:
- mi32/tiffext.h
