Struct dmio::DMImage [−][src]
pub struct DMImage { /* fields omitted */ }
Methods
impl DMImage
[src]
impl DMImage
pub fn ind(&self, x: usize, y: usize, z: usize) -> &f32
[src]
pub fn ind(&self, x: usize, y: usize, z: usize) -> &f32
Returns the element at given indices by reference.
Panics if the element at given indices does not exist.
pub fn sizex(&self) -> usize
[src]
pub fn sizex(&self) -> usize
Returns the number of image pixels on the x-axis.
pub fn sizey(&self) -> usize
[src]
pub fn sizey(&self) -> usize
Returns the number of image pixels on the y-axis.
pub fn sizez(&self) -> usize
[src]
pub fn sizez(&self) -> usize
Returns the number of image pixels on the z-axis.
pub fn shape(&self) -> Vec<usize>
[src]
pub fn shape(&self) -> Vec<usize>
pub fn is_bigendian(&self) -> bool
[src]
pub fn is_bigendian(&self) -> bool
Returns true if image has endianess BigEndian
.
pub fn data(&self) -> &Vec<f32>
[src]
pub fn data(&self) -> &Vec<f32>
Returns a reference to the raw data vector of the image.
On error panics.
pub fn data_mut(&mut self) -> &mut Vec<f32>
[src]
pub fn data_mut(&mut self) -> &mut Vec<f32>
Returns a mutable reference to the raw data vector of the image.
On error panics.
pub unsafe fn replace_data_with(
&mut self,
new_data: Vec<f32>,
shape: &[usize]
) -> Result<()>
[src]
pub unsafe fn replace_data_with(
&mut self,
new_data: Vec<f32>,
shape: &[usize]
) -> Result<()>
The use of this function is deprecated, use the DMImage::new()
function instead or
operate directly on the data of an opened image
pub fn new(shape: &[usize]) -> DMImage
[src]
pub fn new(shape: &[usize]) -> DMImage
Creates a new, empty image.
pub fn open(filepath: &str) -> Result<DMImage>
[src]
pub fn open(filepath: &str) -> Result<DMImage>
Opens and reads an existing DMImage given by the path and returns it as Result<DMImage>
.
If open fails, an std::io::Error is returned.
pub fn save_as<R: DMImageWriteByVersion>(
&mut self,
filepath: &str
) -> Result<()>
[src]
pub fn save_as<R: DMImageWriteByVersion>(
&mut self,
filepath: &str
) -> Result<()>
Save DMImage to file given by filepath.
pub fn get_min(&self) -> f32
[src]
pub fn get_min(&self) -> f32
Returns the smallest value in the image.
pub fn get_max(&self) -> f32
[src]
pub fn get_max(&self) -> f32
Returns the smallest value in the image.
pub fn to_raw_rgb(&self) -> Vec<u8>
[src]
pub fn to_raw_rgb(&self) -> Vec<u8>
Returns the image as rgb values in a raw vector Vec<u8>
.
Trait Implementations
impl Debug for DMImage
[src]
impl Debug for DMImage
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Default for DMImage
[src]
impl Default for DMImage
impl Index<[usize; 3]> for DMImage
[src]
impl Index<[usize; 3]> for DMImage
type Output = f32
The returned type after indexing.
fn index(&self, index: [usize; 3]) -> &f32
[src]
fn index(&self, index: [usize; 3]) -> &f32
Performs the indexing (container[index]
) operation.
impl IndexMut<[usize; 3]> for DMImage
[src]
impl IndexMut<[usize; 3]> for DMImage
fn index_mut(&mut self, index: [usize; 3]) -> &mut f32
[src]
fn index_mut(&mut self, index: [usize; 3]) -> &mut f32
Performs the mutable indexing (container[index]
) operation.
impl Index<[usize; 2]> for DMImage
[src]
impl Index<[usize; 2]> for DMImage
type Output = f32
The returned type after indexing.
fn index(&self, index: [usize; 2]) -> &f32
[src]
fn index(&self, index: [usize; 2]) -> &f32
Performs the indexing (container[index]
) operation.
impl IndexMut<[usize; 2]> for DMImage
[src]
impl IndexMut<[usize; 2]> for DMImage