BioGTK.Resolution Struct Reference

Public Member Functions
	Resolution (int w, int h, int omePx, int bitsPerPixel, double physX, double physY, double physZ, double stageX, double stageY, double stageZ)
	Resolution (int w, int h, PixelFormat f, double physX, double physY, double physZ, double stageX, double stageY, double stageZ)
Resolution	Copy ()
override string	ToString ()

Public Attributes
int	x
int	y
PixelFormat	format
double	px
double	py
double	pz
double	sx
double	sy
double	sz

Properties
int	SizeX [get, set]
int	SizeY [get, set]
double	PhysicalSizeX [get, set]
double	PhysicalSizeY [get, set]
double	PhysicalSizeZ [get, set]
double	StageSizeX [get, set]
double	StageSizeY [get, set]
double	StageSizeZ [get, set]
double	VolumeWidth [get]
double	VolumeHeight [get]
PixelFormat	PixelFormat [get, set]
int	RGBChannelsCount [get]
long	SizeInBytes [get]

Constructor & Destructor Documentation

Resolution() [1/2]

BioGTK.Resolution.Resolution ( int  w, int  h, int  omePx, int  bitsPerPixel, double  physX, double  physY, double  physZ, double  stageX, double  stageY, double  stageZ  )

inline

        {
            x = w;
            y = h;
            sx = stageX;
            sy = stageY;
            sz = stageZ;
            format = BioImage.GetPixelFormat(omePx, bitsPerPixel);
            px = physX;
            py = physY;
            pz = physZ;
        }

Resolution() [2/2]

BioGTK.Resolution.Resolution ( int  w, int  h, PixelFormat  f, double  physX, double  physY, double  physZ, double  stageX, double  stageY, double  stageZ  )

inline

        {
            x = w;
            y = h;
            format = f;
            sx = stageX;
            sy = stageY;
            sz = stageZ;
            px = physX;
            py = physY;
            pz = physZ;
        }

Member Function Documentation

Copy()

Resolution BioGTK.Resolution.Copy ( )

inline

        {
            return new Resolution(x, y, format, px, py, pz, sx, sy, sz);
        }

ToString()

override string BioGTK.Resolution.ToString ( )

inline

        {
            return "(" + x + ", " + y + ") " + format.ToString() + " " + (SizeInBytes / 1000) + " KB";
        }

Member Data Documentation

format

PixelFormat BioGTK.Resolution.format

px

double BioGTK.Resolution.px

py

double BioGTK.Resolution.py

pz

double BioGTK.Resolution.pz

sx

double BioGTK.Resolution.sx

sy

double BioGTK.Resolution.sy

sz

double BioGTK.Resolution.sz

x

int BioGTK.Resolution.x

y

int BioGTK.Resolution.y

Property Documentation

PhysicalSizeX

double BioGTK.Resolution.PhysicalSizeX

getset

        {
            get { return px; }
            set { px = value; }
        }

PhysicalSizeY

double BioGTK.Resolution.PhysicalSizeY

getset

        {
            get { return py; }
            set { py = value; }
        }

PhysicalSizeZ

double BioGTK.Resolution.PhysicalSizeZ

getset

        {
            get { return pz; }
            set { pz = value; }
        }

PixelFormat

PixelFormat BioGTK.Resolution.PixelFormat

getset

        {
            get { return format; }
            set { format = value; }
        }

RGBChannelsCount

int BioGTK.Resolution.RGBChannelsCount

get

        {
            get
            {
                if (PixelFormat == PixelFormat.Format8bppIndexed || PixelFormat == PixelFormat.Format16bppGrayScale)
                    return 1;
                else if (PixelFormat == PixelFormat.Format24bppRgb || PixelFormat == PixelFormat.Format48bppRgb)
                    return 3;
                else
                    return 4;
            }
        }

SizeInBytes

long BioGTK.Resolution.SizeInBytes

get

        {
            get
            {
                if (format == PixelFormat.Format8bppIndexed)
                    return (long)y * (long)x;
                else if (format == PixelFormat.Format16bppGrayScale)
                    return (long)y * (long)x * 2;
                else if (format == PixelFormat.Format24bppRgb)
                    return (long)y * (long)x * 3;
                else if (format == PixelFormat.Format32bppRgb || format == PixelFormat.Format32bppArgb)
                    return (long)y * (long)x * 4;
                else if (format == PixelFormat.Format48bppRgb || format == PixelFormat.Format48bppRgb)
                    return (long)y * (long)x * 6;
                throw new NotSupportedException(format + " is not supported.");
            }
        }

SizeX

int BioGTK.Resolution.SizeX

getset

        {
            get { return x; }
            set { x = value; }
        }

SizeY

int BioGTK.Resolution.SizeY

getset

        {
            get { return y; }
            set { y = value; }
        }

StageSizeX

double BioGTK.Resolution.StageSizeX

getset

        {
            get { return sx; }
            set { sx = value; }
        }

StageSizeY

double BioGTK.Resolution.StageSizeY

getset

        {
            get { return sy; }
            set { sy = value; }
        }

StageSizeZ

double BioGTK.Resolution.StageSizeZ

getset

        {
            get { return sz; }
            set { sz = value; }
        }

VolumeHeight

double BioGTK.Resolution.VolumeHeight

get

        {
            get
            {
                return PhysicalSizeY * SizeY;
            }
        }

VolumeWidth

double BioGTK.Resolution.VolumeWidth

get

        {
            get
            {
                return PhysicalSizeX * SizeX;
            }
        }

---

The documentation for this struct was generated from the following file:

• D:/Kari/repos/BioGTK/Source/Bio.cs