Generic image implementation for PNM files. More...
#include <vil_pnm.h>
Public Member Functions | |
| vil_pnm_image (vil_stream *is, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format) | |
| vil_pnm_image (vil_stream *is) | |
| ~vil_pnm_image () override | |
| unsigned | nplanes () const override |
| Dimensions: Planes x ni x nj. More... | |
| unsigned | ni () const override |
| Dimensions: Planes x ni x nj. More... | |
| unsigned | nj () const override |
| Dimensions: Planes x ni x nj. More... | |
| enum vil_pixel_format | pixel_format () const override |
| Pixel Format. More... | |
| vil_image_view_base_sptr | get_copy_view (unsigned i0, unsigned ni, unsigned j0, unsigned nj) const override |
| Create a read/write view of a copy of this data. More... | |
| bool | put_view (const vil_image_view_base &im, unsigned i0, unsigned j0) override |
| Put the data in this view back into the image source. More... | |
| char const * | file_format () const override |
| Return a string describing the file format. More... | |
| bool | get_property (char const *tag, void *prop=nullptr) const override |
| Extra property information. More... | |
| virtual vil_image_view_base_sptr | get_view (unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) const |
| Create a read/write view of the data. More... | |
| vil_image_view_base_sptr | get_view () const |
| Create a read/write view of all the data. More... | |
| vil_image_view_base_sptr | get_copy_view () const |
| Create a read/write view of a copy of all the data. More... | |
| virtual bool | put_view (const vil_image_view_base &im) |
| Put the data in this view back into the image source at the origin. More... | |
| virtual bool | view_fits (const vil_image_view_base &im, unsigned i0, unsigned j0) |
| Check that a view will fit into the data at the given offset. More... | |
Protected Member Functions | |
| void | ref () |
| void | unref () |
Protected Attributes | |
| vcl_atomic_count | reference_count_ |
Private Member Functions | |
| bool | read_header () |
| This method accepts any valid PNM file (first 3 bytes "P1\n" to "P6\n"). More... | |
| bool | write_header () |
Private Attributes | |
| vil_stream * | vs_ |
| int | magic_ |
| unsigned | ni_ |
| unsigned | nj_ |
| unsigned long int | maxval_ |
| vil_streampos | start_of_data_ |
| unsigned | ncomponents_ |
| unsigned | bits_per_component_ |
| vil_pixel_format | format_ |
| Describe the format of each pixel. More... | |
Friends | |
| class | vil_pnm_file_format |
Related Functions | |
(Note that these are not member functions.) | |
| template<class destT , class kernelT , class accumT > | |
| vil_image_resource_sptr | vil_convolve_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, int k_lo, int k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option) |
| Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT. More... | |
| template<class destT , class kernelT , class accumT > | |
| vil_image_resource_sptr | vil_correlate_1d (const vil_image_resource_sptr &src_im, const destT, const kernelT *kernel, std::ptrdiff_t k_lo, std::ptrdiff_t k_hi, const accumT, vil_convolve_boundary_option start_option, vil_convolve_boundary_option end_option) |
| Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT. More... | |
| vil_image_resource_sptr | vil_clamp (const vil_image_resource_sptr &src, double low, double hi) |
| Clamp an image resource between two values. More... | |
| bool | vil_copy_deep (const vil_image_resource_sptr &src, vil_image_resource_sptr &dest) |
| Copy src to dest. More... | |
| vil_image_resource_sptr | vil_copy_deep (const vil_image_resource_sptr &src) |
| Creates an in memory vil_image_resource and copies the src to it. More... | |
| vil_image_resource_sptr | vil_crop (const vil_image_resource_sptr &src, unsigned i0, unsigned n_i, unsigned j0, unsigned n_j) |
| Crop to a region of src. More... | |
| vil_image_resource_sptr | vil_decimate (const vil_image_resource_sptr &src, unsigned i_factor, unsigned j_factor=0) |
| decimate to a region of src. More... | |
| vil_image_resource_sptr | vil_flip_lr (const vil_image_resource_sptr &src) |
| Flip an image resource left to right. More... | |
| vil_image_resource_sptr | vil_flip_ud (const vil_image_resource_sptr &src) |
| Flip an image resource left to right. More... | |
| vil_image_resource_sptr | vil_load_image_resource (char const *filename, bool verbose=true) |
| Load an image resource object from a file. More... | |
| vil_image_resource_sptr | vil_load_image_resource_raw (vil_stream *, bool verbose=true) |
| Load from a stream. More... | |
| vil_image_resource_sptr | vil_load_image_resource_raw (char const *, bool verbose=true) |
| Load an image resource object from a file. More... | |
| vil_image_resource_sptr | vil_load_image_resource_plugin (char const *) |
| Load from a filename with a plugin. More... | |
| template<class sumT > | |
| bool | vil_math_mean_and_variance (sumT &mean, sumT &var, const vil_image_resource_sptr im, const vil_image_view< bool > &mask, unsigned p) |
| Mean and variance of masked elements in plane p for vil_image_resource. More... | |
| vil_image_resource_sptr | vil_new_image_resource (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format) |
| Make a new image of given format. More... | |
| vil_image_resource_sptr | vil_new_image_resource (unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype) |
| Make a new image, similar format to the prototype. More... | |
| vil_image_resource_sptr | vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const *file_format) |
| Make a new image. More... | |
| vil_image_resource_sptr | vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const *file_format) |
| Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype". More... | |
| vil_image_resource_sptr | vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format, char const *file_format) |
| Make a new image. More... | |
| vil_image_resource_sptr | vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, vil_image_resource_sptr const &prototype, char const *file_format) |
| Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype". More... | |
| vil_image_resource_sptr | vil_new_image_resource (char const *filename, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const *format=nullptr) |
| Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype". More... | |
| vil_image_resource_sptr | vil_new_image_resource (vil_stream *os, unsigned ni, unsigned nj, unsigned nplanes, vil_image_resource_sptr const &prototype, char const *file_format=nullptr) |
| Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype". More... | |
| vil_image_resource_sptr | vil_new_image_resource_interleaved (unsigned ni, unsigned nj, unsigned nplanes, vil_pixel_format format) |
| Make a new image of given format with interleaved planes. More... | |
| vil_image_resource_sptr | vil_new_image_resource_of_view (vil_image_view_base const &view) |
| Make a new image resource that is a wrapper on an existing view's data. More... | |
| vil_image_resource_sptr | vil_plane (const vil_image_resource_sptr &src, unsigned p) |
| Return a specific plane of an image. More... | |
| bool | vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename, char const *file_format) |
| Send vil_image_resource to disk. More... | |
| bool | vil_save_image_resource (const vil_image_resource_sptr &ir, char const *filename) |
| Save vil_image_resource to file, deducing format from filename. More... | |
| vil_image_resource_sptr | vil_transpose (const vil_image_resource_sptr &src) |
| Transpose an image. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ vil_pnm_image() [1/2]
| vil_pnm_image::vil_pnm_image | ( | vil_stream * | is, |
| unsigned | ni, | ||
| unsigned | nj, | ||
| unsigned | nplanes, | ||
| vil_pixel_format | format | ||
| ) |
Definition at line 97 of file vil_pnm.cxx.
◆ vil_pnm_image() [2/2]
| vil_pnm_image::vil_pnm_image | ( | vil_stream * | is | ) |
Definition at line 73 of file vil_pnm.cxx.
◆ ~vil_pnm_image()
|
override |
Definition at line 145 of file vil_pnm.cxx.
Member Function Documentation
◆ file_format()
|
overridevirtual |
Return a string describing the file format.
Only file images have a format, others return 0
Reimplemented from vil_image_resource.
Definition at line 92 of file vil_pnm.cxx.
◆ get_copy_view() [1/2]
|
inlineinherited |
Create a read/write view of a copy of all the data.
Definition at line 80 of file vil_image_resource.h.
◆ get_copy_view() [2/2]
|
overridevirtual |
Create a read/write view of a copy of this data.
This function will always return a multi-plane scalar-pixel view of the data.
- Returns
- 0 if unable to get view of correct size, or if resource is write-only.
Implements vil_image_resource.
Definition at line 314 of file vil_pnm.cxx.
◆ get_property()
|
overridevirtual |
Extra property information.
Implements vil_image_resource.
Definition at line 80 of file vil_pnm.cxx.
◆ get_view() [1/2]
|
inlinevirtualinherited |
Create a read/write view of the data.
Modifying this view might modify the actual data. If you want to modify this data in place, call put_view after you done, and it should work efficiently. This function will always return a multi-plane scalar-pixel view of the data.
- Returns
- 0 if unable to get view of correct size, or if resource is write-only.
If you want to fill an existing view (e.g. a window onto some other image), then use
vil_reformat(data->get_view(..), window);
Reimplemented in vil_flip_ud_image_resource, vil_memory_image, vil_plane_image_resource, vil_clamp_image_resource, vil_flip_lr_image_resource, vil_decimate_image_resource, vil_dicom_image, vil_crop_image_resource, and vil_transpose_image_resource.
Definition at line 64 of file vil_image_resource.h.
◆ get_view() [2/2]
|
inlineinherited |
Create a read/write view of all the data.
Definition at line 69 of file vil_image_resource.h.
◆ ni()
|
inlineoverridevirtual |
◆ nj()
|
inlineoverridevirtual |
◆ nplanes()
|
inlineoverridevirtual |
Dimensions: Planes x ni x nj.
This concept is treated as a synonym to components.
Implements vil_image_resource.
◆ pixel_format()
|
inlineoverridevirtual |
Pixel Format.
A standard RGB RGB RGB of chars image has pixel_format() == VIL_PIXEL_FORMAT_BYTE
Implements vil_image_resource.
◆ put_view() [1/2]
|
inlinevirtualinherited |
Put the data in this view back into the image source at the origin.
Reimplemented in vil_j2k_image.
Definition at line 92 of file vil_image_resource.h.
◆ put_view() [2/2]
|
overridevirtual |
Put the data in this view back into the image source.
The view must be of scalar components. Assign your view to a scalar-component view if this is not the case.
- Returns
- false if failed, because e.g. resource is read-only, format of view is not correct (if it is a compound pixel type, try assigning it to a multi-plane scalar pixel view.)
Implements vil_image_resource.
Definition at line 474 of file vil_pnm.cxx.
◆ read_header()
|
private |
This method accepts any valid PNM file (first 3 bytes "P1\n" to "P6\n").
Definition at line 207 of file vil_pnm.cxx.
◆ ref()
|
inlineprotectedinherited |
Definition at line 110 of file vil_image_resource.h.
◆ unref()
|
inlineprotectedinherited |
Definition at line 111 of file vil_image_resource.h.
◆ view_fits()
|
virtualinherited |
Check that a view will fit into the data at the given offset.
This includes checking that the pixel type is scalar.
Reimplemented in vil_j2k_image.
Definition at line 27 of file vil_image_resource.cxx.
◆ write_header()
|
private |
Definition at line 288 of file vil_pnm.cxx.
Friends And Related Function Documentation
◆ vil_clamp()
|
related |
Clamp an image resource between two values.
Definition at line 22 of file vil_clamp.cxx.
◆ vil_convolve_1d()
|
related |
Create an image_resource object which convolve kernel[x] x in [k_lo,k_hi] with srcT.
- Note
- This function reverses the kernel. If you don't want the kernel reversed, use vil_correlate_1d instead.
- Parameters
-
kernel should point to tap 0.
Definition at line 406 of file vil_convolve_1d.h.
◆ vil_copy_deep() [1/2]
|
related |
Copy src to dest.
This is useful if you want to copy on image into a window on another image. src and dest must have identical sizes, and pixel-types. Returns false if the copy failed. O(size).
Definition at line 45 of file vil_copy.cxx.
◆ vil_copy_deep() [2/2]
|
related |
Creates an in memory vil_image_resource and copies the src to it.
The size and pixel type of the return vil_image_resource is determined by src O(size)
Definition at line 89 of file vil_copy.cxx.
◆ vil_correlate_1d()
|
related |
Create an image_resource object which correlate kernel[x] x in [k_lo,k_hi] with srcT.
- Note
- This function does not reverse the kernel. If you want the kernel reversed, use vil_convolve_1d instead.
- Parameters
-
kernel should point to tap 0.
Definition at line 218 of file vil_correlate_1d.h.
◆ vil_crop()
|
related |
Crop to a region of src.
Definition at line 15 of file vil_crop.cxx.
◆ vil_decimate()
|
related |
decimate to a region of src.
Definition at line 23 of file vil_decimate.cxx.
◆ vil_flip_lr()
|
related |
Flip an image resource left to right.
Definition at line 14 of file vil_flip.cxx.
◆ vil_flip_ud()
|
related |
Flip an image resource left to right.
Definition at line 121 of file vil_flip.cxx.
◆ vil_load_image_resource()
|
related |
Load an image resource object from a file.
Definition at line 68 of file vil_load.cxx.
◆ vil_load_image_resource_plugin()
|
related |
Load from a filename with a plugin.
Definition at line 80 of file vil_load.cxx.
◆ vil_load_image_resource_raw() [1/2]
|
related |
◆ vil_load_image_resource_raw() [2/2]
|
related |
Load an image resource object from a file.
Won't use plugins.
Definition at line 46 of file vil_load.cxx.
◆ vil_math_mean_and_variance()
|
related |
Mean and variance of masked elements in plane p for vil_image_resource.
Definition at line 380 of file vil_math.h.
◆ vil_new_image_resource() [1/8]
|
related |
Make a new image of given format.
If the format is not scalar, the number of planes must be 1. When you create a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)
Definition at line 32 of file vil_new.cxx.
◆ vil_new_image_resource() [2/8]
|
related |
Make a new image, similar format to the prototype.
Definition at line 69 of file vil_new.cxx.
◆ vil_new_image_resource() [3/8]
|
related |
Make a new image.
Definition at line 77 of file vil_new.cxx.
◆ vil_new_image_resource() [4/8]
|
related |
Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".
◆ vil_new_image_resource() [5/8]
|
related |
Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".
◆ vil_new_image_resource() [6/8]
|
related |
Make a new vil_image_resource, writing to file "filename", size ni x nj, copying pixel format etc from "prototype".
Definition at line 104 of file vil_new.cxx.
◆ vil_new_image_resource() [7/8]
|
related |
Make a new image.
Definition at line 123 of file vil_new.cxx.
◆ vil_new_image_resource() [8/8]
|
related |
Make a new vil_image_resource, writing to stream "os", size ni x nj, copying pixel format etc from "prototype".
Definition at line 143 of file vil_new.cxx.
◆ vil_new_image_resource_interleaved()
|
related |
Make a new image of given format with interleaved planes.
The format must be scalar.
Definition at line 44 of file vil_new.cxx.
◆ vil_new_image_resource_of_view()
|
related |
Make a new image resource that is a wrapper on an existing view's data.
- Note
- The output will be a shallow copy of the input, so changing the pixel values of one may change the pixel value of the other. Thanks to the magic of smart pointers, the output will remain valid even if you destroy the input. When you wrap a multi-component image in this way, the vil_image_resource API will treat it as a scalar pixel image with multiple planes. (This doesn't affect the underlying data storage.)
Definition at line 62 of file vil_new.cxx.
◆ vil_plane()
|
related |
Return a specific plane of an image.
Definition at line 19 of file vil_plane.cxx.
◆ vil_pnm_file_format
|
friend |
◆ vil_save_image_resource() [1/2]
|
related |
Send vil_image_resource to disk.
Definition at line 129 of file vil_save.cxx.
◆ vil_save_image_resource() [2/2]
|
related |
Save vil_image_resource to file, deducing format from filename.
Definition at line 148 of file vil_save.cxx.
◆ vil_transpose()
|
related |
Transpose an image.
Definition at line 14 of file vil_transpose.cxx.
Member Data Documentation
◆ bits_per_component_
◆ format_
|
private |
◆ magic_
◆ maxval_
◆ ncomponents_
◆ ni_
◆ nj_
◆ reference_count_
|
protectedinherited |
Definition at line 114 of file vil_image_resource.h.
◆ start_of_data_
|
private |
◆ vs_
|
private |
The documentation for this class was generated from the following files:
- core/vil/file_formats/vil_pnm.h
- core/vil/file_formats/vil_pnm.cxx
