Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
vil_tiff_header Class Reference

#include <vil_tiff_header.h>

List of all members.

Public Member Functions

 vil_tiff_header (TIFF *tif)
 vil_tiff_header (TIFF *tif, const unsigned ni, const unsigned nj, const unsigned nplanes, vil_pixel_format const &fmt, const unsigned size_block_i, const unsigned size_block_j)
vxl_uint_16 bytes_per_sample () const
vxl_uint_32 bytes_per_line () const
 theoretical from samples per line.
vxl_uint_32 actual_bytes_per_line () const
 As returned by the TIFF library.
vxl_uint_32 rows_in_strip () const
vxl_uint_32 strips_per_image () const
vxl_uint_32 actual_bytes_per_strip (const vxl_uint_32 strip_index) const
vxl_uint_32 bytes_per_strip () const
vxl_uint_32 tiles_across () const
vxl_uint_32 tiles_down () const
vxl_uint_32 tiles_per_image () const
vxl_uint_32 bytes_per_tile () const
unsigned n_separate_image_planes () const
 the actual number of separate image planes in the tiff image.
unsigned encoded_bytes_per_block () const
 the number of encoded bytes in a tile or strip.
unsigned samples_per_line () const
 the number of samples in a block.
bool is_tiled () const
 is the image tiled.
bool is_striped () const
 is the image striped (one of these must be true or read failed).
bool need_byte_swap ()
vxl_uint_16 n_images ()
 the number of images in the file.

Public Attributes

vcl_string artist
ushort_tag bits_per_sample
ushort_tag cell_length
ushort_tag cell_width
vcl_vector< vcl_vector
< vxl_uint_16 > > 
color_map
bool color_map_valid
ushort_tag compression
vcl_string copyright
vcl_string date_time
ushort_tag extra_samples
ushort_tag fill_order
vcl_vector< vxl_uint_16 > gray_response_curve
bool grey_response_curve_valid
ushort_tag gray_response_unit
vcl_string host_computer
vcl_string image_description
ulong_tag image_length
ulong_tag image_width
unsigned nplanes
vcl_string make
ushort_tag max_sample_value
ushort_tag min_sample_value
vcl_string model
ushort_tag orientation
ushort_tag photometric
ushort_tag planar_config
ushort_tag resolution_unit
ulong_tag rows_per_strip
ushort_tag sample_format
ushort_tag samples_per_pixel
vcl_string software
vxl_uint_32 * strip_byte_counts
bool strip_byte_counts_valid
vxl_uint_32 * strip_offsets
bool strip_offsets_valid
ushort_tag subfile_type
ushort_tag thresholding
float x_resolution
bool x_resolution_valid
float y_resolution
bool y_resolution_valid
bool is_tiled_flag
ulong_tag tile_width
ulong_tag tile_length
vxl_uint_32 * tile_offsets
bool tile_offsets_valid
vxl_uint_32 * tile_byte_counts
bool tile_byte_counts_valid
vil_pixel_format pix_fmt
bool format_supported
 true if the specified format can be read or written.

Private Member Functions

bool read_header ()
 read/write mode true for read.
bool set_header (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format const &fmt, const unsigned size_block_i, const unsigned size_block_j)
 returns false if the format cannot be written by current version.
bool compute_pixel_format ()
 returns false if the format not handled by this reader.
bool parse_pixel_format (vil_pixel_format const &fmt)
 returns false if the format not handled by this writer.

Private Attributes

TIFF * tif_
bool file_is_big_endian_
bool machine_is_big_endian_

Detailed Description

Definition at line 67 of file vil_tiff_header.h.


Constructor & Destructor Documentation

vil_tiff_header::vil_tiff_header ( TIFF *  tif) [inline]

Definition at line 70 of file vil_tiff_header.h.

vil_tiff_header::vil_tiff_header ( TIFF *  tif,
const unsigned  ni,
const unsigned  nj,
const unsigned  nplanes,
vil_pixel_format const &  fmt,
const unsigned  size_block_i,
const unsigned  size_block_j 
)

Definition at line 678 of file vil_tiff_header.cxx.


Member Function Documentation

vxl_uint_32 vil_tiff_header::actual_bytes_per_line ( ) const

As returned by the TIFF library.

Definition at line 302 of file vil_tiff_header.cxx.

vxl_uint_32 vil_tiff_header::actual_bytes_per_strip ( const vxl_uint_32  strip_index) const

Definition at line 325 of file vil_tiff_header.cxx.

vxl_uint_32 vil_tiff_header::bytes_per_line ( ) const

theoretical from samples per line.

Definition at line 295 of file vil_tiff_header.cxx.

vxl_uint_16 vil_tiff_header::bytes_per_sample ( ) const [inline]

Definition at line 82 of file vil_tiff_header.h.

vxl_uint_32 vil_tiff_header::bytes_per_strip ( ) const

Definition at line 333 of file vil_tiff_header.cxx.

vxl_uint_32 vil_tiff_header::bytes_per_tile ( ) const

Definition at line 338 of file vil_tiff_header.cxx.

bool vil_tiff_header::compute_pixel_format ( ) [private]

returns false if the format not handled by this reader.

(samples_per_pixel.valid) ||

Definition at line 351 of file vil_tiff_header.cxx.

unsigned vil_tiff_header::encoded_bytes_per_block ( ) const

the number of encoded bytes in a tile or strip.

Definition at line 277 of file vil_tiff_header.cxx.

bool vil_tiff_header::is_striped ( ) const

is the image striped (one of these must be true or read failed).

Definition at line 261 of file vil_tiff_header.cxx.

bool vil_tiff_header::is_tiled ( ) const

is the image tiled.

Definition at line 255 of file vil_tiff_header.cxx.

vxl_uint_16 vil_tiff_header::n_images ( )

the number of images in the file.

Definition at line 344 of file vil_tiff_header.cxx.

unsigned vil_tiff_header::n_separate_image_planes ( ) const

the actual number of separate image planes in the tiff image.

Definition at line 240 of file vil_tiff_header.cxx.

bool vil_tiff_header::need_byte_swap ( ) [inline]

Definition at line 234 of file vil_tiff_header.h.

bool vil_tiff_header::parse_pixel_format ( vil_pixel_format const &  fmt) [private]

returns false if the format not handled by this writer.

Definition at line 584 of file vil_tiff_header.cxx.

bool vil_tiff_header::read_header ( void  ) [private]

read/write mode true for read.

returns false if the format cannot be read by current version

-----------------------------------------------///

-----------------------------------------------///

Definition at line 96 of file vil_tiff_header.cxx.

vxl_uint_32 vil_tiff_header::rows_in_strip ( ) const

Definition at line 307 of file vil_tiff_header.cxx.

unsigned vil_tiff_header::samples_per_line ( ) const

the number of samples in a block.

Definition at line 288 of file vil_tiff_header.cxx.

bool vil_tiff_header::set_header ( unsigned  ni,
unsigned  nj,
unsigned  nplanes,
vil_pixel_format const &  fmt,
const unsigned  size_block_i,
const unsigned  size_block_j 
) [private]

returns false if the format cannot be written by current version.

Definition at line 618 of file vil_tiff_header.cxx.

vxl_uint_32 vil_tiff_header::strips_per_image ( ) const [inline]

Definition at line 148 of file vil_tiff_header.h.

vxl_uint_32 vil_tiff_header::tiles_across ( ) const [inline]

Definition at line 201 of file vil_tiff_header.h.

vxl_uint_32 vil_tiff_header::tiles_down ( ) const [inline]

Definition at line 206 of file vil_tiff_header.h.

vxl_uint_32 vil_tiff_header::tiles_per_image ( ) const [inline]

Definition at line 211 of file vil_tiff_header.h.


Member Data Documentation

Definition at line 76 of file vil_tiff_header.h.

Definition at line 81 of file vil_tiff_header.h.

Definition at line 85 of file vil_tiff_header.h.

Definition at line 87 of file vil_tiff_header.h.

vcl_vector<vcl_vector<vxl_uint_16> > vil_tiff_header::color_map

Definition at line 91 of file vil_tiff_header.h.

Definition at line 92 of file vil_tiff_header.h.

Definition at line 94 of file vil_tiff_header.h.

Definition at line 96 of file vil_tiff_header.h.

Definition at line 98 of file vil_tiff_header.h.

Definition at line 101 of file vil_tiff_header.h.

Definition at line 261 of file vil_tiff_header.h.

Definition at line 103 of file vil_tiff_header.h.

true if the specified format can be read or written.

check and return a null resource if false

Definition at line 243 of file vil_tiff_header.h.

vcl_vector<vxl_uint_16> vil_tiff_header::gray_response_curve

Definition at line 107 of file vil_tiff_header.h.

Definition at line 111 of file vil_tiff_header.h.

Definition at line 108 of file vil_tiff_header.h.

Definition at line 113 of file vil_tiff_header.h.

Definition at line 114 of file vil_tiff_header.h.

Definition at line 116 of file vil_tiff_header.h.

Definition at line 124 of file vil_tiff_header.h.

Definition at line 185 of file vil_tiff_header.h.

Definition at line 262 of file vil_tiff_header.h.

Definition at line 128 of file vil_tiff_header.h.

Definition at line 130 of file vil_tiff_header.h.

Definition at line 132 of file vil_tiff_header.h.

Definition at line 134 of file vil_tiff_header.h.

Definition at line 126 of file vil_tiff_header.h.

Definition at line 136 of file vil_tiff_header.h.

Definition at line 138 of file vil_tiff_header.h.

Definition at line 239 of file vil_tiff_header.h.

Definition at line 140 of file vil_tiff_header.h.

Definition at line 142 of file vil_tiff_header.h.

Definition at line 144 of file vil_tiff_header.h.

Definition at line 159 of file vil_tiff_header.h.

Definition at line 160 of file vil_tiff_header.h.

Definition at line 162 of file vil_tiff_header.h.

Definition at line 169 of file vil_tiff_header.h.

Definition at line 170 of file vil_tiff_header.h.

Definition at line 171 of file vil_tiff_header.h.

Definition at line 172 of file vil_tiff_header.h.

Definition at line 174 of file vil_tiff_header.h.

Definition at line 176 of file vil_tiff_header.h.

TIFF* vil_tiff_header::tif_ [private]

Definition at line 248 of file vil_tiff_header.h.

Definition at line 198 of file vil_tiff_header.h.

Definition at line 199 of file vil_tiff_header.h.

Definition at line 189 of file vil_tiff_header.h.

Definition at line 196 of file vil_tiff_header.h.

Definition at line 197 of file vil_tiff_header.h.

Definition at line 187 of file vil_tiff_header.h.

Definition at line 178 of file vil_tiff_header.h.

Definition at line 179 of file vil_tiff_header.h.

Definition at line 181 of file vil_tiff_header.h.

Definition at line 182 of file vil_tiff_header.h.


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