BioImager: BioImager.Resolution Struct Reference

BioImager 3.9.1

A .NET microscopy imaging library. Supports various microscopes by using imported libraries & GUI automation. Supported libraries include Prior® & Zeiss® & all devices supported by Micromanager 2.0 and python-microscope.

Loading...

Searching...

No Matches

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]`

Detailed Description

Definition at line 164 of file Bio.cs.

Constructor & Destructor Documentation

◆ Resolution() [1/2]

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

Definition at line 258 of file Bio.cs.

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

◆ Resolution() [2/2]

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

Definition at line 270 of file Bio.cs.

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

Member Function Documentation

◆ Copy()

Resolution BioImager.Resolution.Copy ( )

Definition at line 282 of file Bio.cs.

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

◆ ToString()

override string BioImager.Resolution.ToString ( )

Definition at line 286 of file Bio.cs.

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

Member Data Documentation

◆ format

PixelFormat BioImager.Resolution.format

Definition at line 168 of file Bio.cs.

◆ px

double BioImager.Resolution.px

Definition at line 169 of file Bio.cs.

◆ py

double BioImager.Resolution.py

Definition at line 169 of file Bio.cs.

◆ pz

double BioImager.Resolution.pz

Definition at line 169 of file Bio.cs.

◆ sx

double BioImager.Resolution.sx

Definition at line 169 of file Bio.cs.

◆ sy

double BioImager.Resolution.sy

Definition at line 169 of file Bio.cs.

◆ sz

double BioImager.Resolution.sz

Definition at line 169 of file Bio.cs.

◆ x

int BioImager.Resolution.x

Definition at line 166 of file Bio.cs.

◆ y

int BioImager.Resolution.y

Definition at line 167 of file Bio.cs.

Property Documentation

◆ PhysicalSizeX

double BioImager.Resolution.PhysicalSizeX

getset

Definition at line 180 of file Bio.cs.

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

◆ PhysicalSizeY

double BioImager.Resolution.PhysicalSizeY

getset

Definition at line 185 of file Bio.cs.

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

◆ PhysicalSizeZ

double BioImager.Resolution.PhysicalSizeZ

getset

Definition at line 190 of file Bio.cs.

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

◆ PixelFormat

PixelFormat BioImager.Resolution.PixelFormat

getset

Definition at line 224 of file Bio.cs.

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

◆ RGBChannelsCount

int BioImager.Resolution.RGBChannelsCount

get

Definition at line 229 of file Bio.cs.

        {
            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 BioImager.Resolution.SizeInBytes

get

Definition at line 241 of file Bio.cs.

        {
            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 BioImager.Resolution.SizeX

getset

Definition at line 170 of file Bio.cs.

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

◆ SizeY

int BioImager.Resolution.SizeY

getset

Definition at line 175 of file Bio.cs.

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

◆ StageSizeX

double BioImager.Resolution.StageSizeX

getset

Definition at line 195 of file Bio.cs.

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

◆ StageSizeY

double BioImager.Resolution.StageSizeY

getset

Definition at line 200 of file Bio.cs.

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

◆ StageSizeZ

double BioImager.Resolution.StageSizeZ

getset

Definition at line 205 of file Bio.cs.

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

◆ VolumeHeight

double BioImager.Resolution.VolumeHeight

get

Definition at line 217 of file Bio.cs.

        {
            get
            {
                return PhysicalSizeY * SizeY;
            }
        }

◆ VolumeWidth

double BioImager.Resolution.VolumeWidth

get

Definition at line 210 of file Bio.cs.

        {
            get
            {
                return PhysicalSizeX * SizeX;
            }
        }

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

F:/repos/BioImager/BioImager/Source/Bio.cs

BioImager
Resolution
Generated by 1.9.5