libimage  0.25.4
 All Classes Namespaces Files Functions Variables Enumerations Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
LibkakaduImage Class Reference

#include <LibkakaduImage.h>

Inheritance diagram for LibkakaduImage:
Inheritance graph
Collaboration diagram for LibkakaduImage:
Collaboration graph

Public Member Functions

int getline (uint8_t *buffer, int line)
int getline (uint16_t *buffer, int line)
int getline (float *buffer, int line)
 ~LibkakaduImage ()
 Default destructor.
void print ()
 JPEG2000 image description output.
- Public Member Functions inherited from Jpeg2000Image
int writeImage (Image *pIn)
int writeImage (uint8_t *buffer)
int writeImage (uint16_t *buffer)
int writeImage (float *buffer)
int writeLine (uint8_t *buffer, int line)
int writeLine (uint16_t *buffer, int line)
int writeLine (float *buffer, int line)
- Public Member Functions inherited from FileImage
void unassociateAlpha (uint8_t *buffer)
char * getFilename ()
 Return the path to image file.
int getBitsPerSample ()
 Return number of bits per sample.
Photometric::ePhotometric getPhotometric ()
 Return data photometric (rgb, gray...)
ExtraSample::eExtraSample getExtraSample ()
 Return extra sample type.
void setExtraSample (ExtraSample::eExtraSample es)
 Modify extra sample type.
Compression::eCompression getCompression ()
 Return data compression.
SampleFormat::eSampleFormat getSampleFormat ()
 Return sample format (integer, float)
int getPixelSize ()
 Return the pixel's byte size.
 ~FileImage ()
 Default destructor.
- Public Member Functions inherited from Image
void makeMask ()
 Define the image as a mask.
int getWidth ()
 Return the image's width.
int getHeight ()
 Return the image's height.
void setBbox (BoundingBox< double > box)
 Define the image's bounding box and calculate resolutions.
bool setDimensions (int w, int h, BoundingBox< double > box, double rx, double ry)
 Define the image's bounding box and calculate resolutions.
BoundingBox< double > getBbox () const
 Return the image's bounding box.
void setCRS (CRS srs)
 Define the CRS of the image's bounding box.
CRS getCRS () const
 Return the image's bounding box's CRS.
double getXmin () const
 Return bounding box's xmin.
double getYmax () const
 Return bounding box's ymax.
double getXmax () const
 Return bounding box's xmax.
double getYmin () const
 Return bounding box's ymin.
double getResX () const
 Return the X wise resolution.
double getResY () const
 Return the Y wise resolution.
ImagegetMask ()
 Return the associated mask.
bool setMask (Image *newMask)
 Defined data mask and check consistency.
int x2c (double x)
 Conversion from terrain coordinate X to image column indice.
int y2l (double y)
 Conversion from terrain coordinate Y to image line indice.
double c2x (int c)
 Conversion from image column indice to terrain coordinate X (pixel's center)
double l2y (int l)
 Conversion from image line indice to terrain coordinate X (pixel's center)
double getPhaseX ()
 Phasis calculation, X wise.
double getPhaseY ()
 Phasis calculation, Y wise.
bool isCompatibleWith (Image *pImage)
 Determine compatibility with another image, comparing CRS, phasis and resolutions.
 Image (int width, int height, int channels, double resx, double resy, BoundingBox< double > bbox)
 Create an Image object, from all attributes.
 Image (int width, int height, int channels)
 Create an Image without providing georeferencement, neither resolutions nor bounding box.
 Image (int width, int height, int channels, BoundingBox< double > bbox)
 Create an Image without providing resolutions.
 Image (int width, int height, int channels, double resx, double resy)
 Create an Image object without providing bbox.
virtual ~Image ()
 Default destructor.
virtual void printTFW ()
 Image TFW output.

Static Public Member Functions

static bool canRead (int bps, SampleFormat::eSampleFormat sf)
static bool canWrite (int bps, SampleFormat::eSampleFormat sf)

Protected Member Functions

 LibkakaduImage (int width, int height, double resx, double resy, int channels, BoundingBox< double > bbox, char *name, SampleFormat::eSampleFormat sampleformat, int bitspersample, Photometric::ePhotometric photometric, Compression::eCompression compression, int rps)
 Create a LibkakaduImage object, from all attributes.
bool init ()
 Initialises several member objects, mainly kakadu objects, while out of the constructor.
- Protected Member Functions inherited from Jpeg2000Image
 Jpeg2000Image (int width, int height, double resx, double resy, int channels, BoundingBox< double > bbox, char *name, SampleFormat::eSampleFormat sampleformat, int bitspersample, Photometric::ePhotometric photometric, Compression::eCompression compression)
 Create a Jpeg2000Image object, from all attributes.
- Protected Member Functions inherited from FileImage
 FileImage (int width, int height, double resx, double resy, int channels, BoundingBox< double > bbox, char *name, SampleFormat::eSampleFormat sampleformat, int bitspersample, Photometric::ePhotometric photometric, Compression::eCompression compression, ExtraSample::eExtraSample esType=ExtraSample::ALPHA_UNASSOC)
 Create a FileImage object, from all attributes.
- Protected Member Functions inherited from Image
void computeResolutions ()
 Resolutions calculation, from pixel size and bounding box.

Private Member Functions

template<typename T >
int _getline (T *buffer, int line)
 Returns a line. Values can be floating point numbers or integers.
template<typename T >
void _loadstrip ()
 Preloads a stripe from the source image to a buffer to ease access to lines data.

Private Attributes

int rowsperstrip
 Number of line in one strip.
uint8_t * strip_buffer
 Read buffer, strip_size long.
int current_strip
 Memorized strip indice, in strip_buffer.
kdu_thread_env m_env
 Kakadu threading environment.
kdu_thread_env * m_env_ref
 Kakadu threading environment (pointer)
jp2_family_src jp2_ultimate_src
 Kakadu interface to the raw reading stream from the input image.
jp2_source m_Source
 Kakadu interface to the raw reading stream from the input image.
kdu_codestream m_codestream
 Kakadu formatted image stream.

Friends

class LibkakaduImageFactory

Additional Inherited Members

- Public Attributes inherited from Image
const int channels
 Number of samples per pixel.
- Protected Attributes inherited from FileImage
char * filename
 Path to the image file.
Photometric::ePhotometric photometric
 Data photometric (rgb, gray...)
ExtraSample::eExtraSample esType
 extra sample type (if exists)
Compression::eCompression compression
 Data compression (jpeg, packbits...)
SampleFormat::eSampleFormat sampleformat
 Sample format.
int bitspersample
 Number of bits per sample.
int pixelSize
 Byte pixel's size.

Detailed Description

Author
Institut national de l'information géographique et forestière

Constructor & Destructor Documentation

LibkakaduImage::LibkakaduImage ( int  width,
int  height,
double  resx,
double  resy,
int  channels,
BoundingBox< double >  bbox,
char *  name,
SampleFormat::eSampleFormat  sampleformat,
int  bitspersample,
Photometric::ePhotometric  photometric,
Compression::eCompression  compression,
int  rps 
)
protected

Create a LibkakaduImage object, from all attributes.

Parameters
[in]widthimage width, in pixel
[in]heightimage height, in pixel
[in]resxX wise resolution
[in]resyY wise resolution
[in]channelnumber of samples per pixel
[in]bboxbounding box
[in]namepath to image file
[in]sampleformatsamples' format
[in]bitspersamplenumber of bits per sample
[in]photometricdata photometric
[in]compressiondata compression
[in]kduDatawhole image, in an array
[in]decompressorkakadu stripe decompressor, to load image stripe by stripe
[in]rowsperstripdata buffering size, in line number
LibkakaduImage::~LibkakaduImage ( )
inline

Default destructor.

We remove read buffer #m_data

Member Function Documentation

template<typename T >
int LibkakaduImage::_getline ( T *  buffer,
int  line 
)
private

Returns a line. Values can be floating point numbers or integers.

Parameters
[out]bufferArray containing at least width*channels values
[in]lineIndex of the line to return (0 <= line < height)
Returns
buffer effective size, 0 if error
bool LibkakaduImage::init ( )
protected

Initialises several member objects, mainly kakadu objects, while out of the constructor.

Returns
'true' if success, 'false' if an error occured.

Here is the caller graph for this function:


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