Aardvark.Base


PixImage<'T>

The generic PixImage stores an image with a specific channel type that is specified as type parameter.

Constructors

ConstructorDescription
new(format, volume)
Signature: (format:Format * volume:Volume<'T>) -> unit
new()
Signature: unit -> unit
new(volume)
Signature: volume:Volume<'T> -> unit
new(size, channelCount)
Signature: (size:V2i * channelCount:int64) -> unit
new(size, channelCount)
Signature: (size:V2l * channelCount:int64) -> unit
new(sizeX, sizeY, channelCount)
Signature: (sizeX:int64 * sizeY:int64 * channelCount:int64) -> unit
new(format, size)
Signature: (format:Format * size:V2i) -> unit
new(format, size)
Signature: (format:Format * size:V2l) -> unit
new(format, sizeX, sizeY)
Signature: (format:Format * sizeX:int64 * sizeY:int64) -> unit
new(format, size, channelCount)
Signature: (format:Format * size:V2i * channelCount:int64) -> unit
new(format, size, channelCount)
Signature: (format:Format * size:V2l * channelCount:int64) -> unit
new(format, sizeX, sizeY, channelCount)
Signature: (format:Format * sizeX:int64 * sizeY:int64 * channelCount:int64) -> unit
new(info)
Signature: info:PixImageInfo -> unit
new(channels)
Signature: channels:IEnumerable<Matrix<'T>> -> unit

Create a pixel image from all the given channels in the default format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha).

new(channels)
Signature: (channels:Matrix<'T> []) -> unit

Create a pixel image from all the given channels in the default format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha).

new(format, channels)
Signature: (format:Format * channels:IEnumerable<Matrix<'T>>) -> unit

Create a pixel image from all the given channels in the specified format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha).

new(format, channels)
Signature: (format:Format * channels:Matrix<'T> []) -> unit

Create a pixel image from all the given channels in the specified format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha).

new(pixImage)
Signature: pixImage:PixImage -> unit

Copy constructor: ALWAYS creates a copy of the data!

new(format, pixImage)
Signature: (format:Format * pixImage:PixImage) -> unit

Copy constructor: ALWAYS creates a copy of the data!

new(bitmap)
Signature: bitmap:Bitmap -> unit
new(filename, options)
Signature: (filename:string * options:PixLoadOptions) -> unit
new(stream, options)
Signature: (stream:Stream * options:PixLoadOptions) -> unit

Instance members

Instance memberDescription
Array
Signature: Array
Modifiers: abstract
BytesPerChannel
Signature: int
ChannelArray
Signature: Matrix<'T> []

Returns the array containing the cahnnels in canonical order: red, green, blue, (alpha).

ChannelCount
Signature: int
Modifiers: abstract
ChannelCountL
Signature: int64
Modifiers: abstract
Channels
Signature: IEnumerable<Matrix<'T>>

Returns the channels of the image in canonical order: red, green, blue, (alpha).

Copy()
Signature: unit -> PixImage<'T>
Copy(fun)
Signature: fun:Func<'Tv,'Tv> -> PixImage<'T>

Copy function for color conversions.

Copy(fun, format)
Signature: (fun:Func<'Tv,'Tv> * format:Format) -> PixImage<'T>

Copy function for color conversions. Note that the new color format must have the same number of channels as the old one, and the result of the supplied conversion function is reinterpreted as a color in the new format.

CopyChannelTo(channelIndex, target)
Signature: (channelIndex:int64 * target:Matrix<'Tv>) -> unit
Modifiers: abstract
CopyToImageLayout()
Signature: unit -> PixImage<'T>
CopyToPixImage()
Signature: unit -> PixImage
Modifiers: abstract
CopyToPixImageWithCanonicalDenseLayout()
Signature: unit -> PixImage
Modifiers: abstract
Data
Signature: Array
Modifiers: abstract
GetChannel(channelIndex)
Signature: channelIndex:int64 -> Matrix<'T>

Returns the specified channel, based on the canonical channel order: red, green, blue, (alpha).

GetChannel(channel)
Signature: channel:Channel -> Matrix<'T>

Returns the specified channel.

GetChannel(channelIndex)
Signature: channelIndex:int64 -> Matrix<'T,'Tv>

Returns the specified channel (based on the canonical order) with a different view type.

GetChannelInFormatOrder(...)
Signature: formatChannelIndex:int64 -> Matrix<'T>

Returns the specified channel based on the order of the image's color format.

GetChannelInFormatOrder(...)
Signature: formatChannelIndex:int64 -> Matrix<'T,'Tv>

Returns the specified channel based on the order of the image's color format with a different view type. formatChannelIndex

GetMatrix()
Signature: unit -> Matrix<'T,'Tv>
IntStride
Signature: int
Modifiers: abstract
Matrix
Signature: Matrix<'T>

Returns the matrix representation of the volume if there is only one channel. Fails if there are multiple channels.

PixFormat
Signature: PixFormat
Modifiers: abstract
Remapped(xMap, yMap, ip)
Signature: (xMap:Matrix<float32> * yMap:Matrix<float32> * ip:ImageInterpolation) -> PixImage<'T>
RemappedPixImage(xMap, yMap, ip)
Signature: (xMap:Matrix<float32> * yMap:Matrix<float32> * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
Resized(newSize, ip)
Signature: (newSize:V2i * ip:ImageInterpolation) -> PixImage<'T>
Resized(xSize, ySize, ip)
Signature: (xSize:int * ySize:int * ip:ImageInterpolation) -> PixImage<'T>
ResizedPixImage(newSize, ip)
Signature: (newSize:V2i * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
Rotated(angleInRadiansCCW, resize, ip)
Signature: (angleInRadiansCCW:float * resize:bool * ip:ImageInterpolation) -> PixImage<'T>
RotatedPixImage(...)
Signature: (angleInRadiansCCW:float * resize:bool * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
Scaled(scaleFactor, ip)
Signature: (scaleFactor:V2d * ip:ImageInterpolation) -> PixImage<'T>
Scaled(scaleFactor, ip)
Signature: (scaleFactor:float * ip:ImageInterpolation) -> PixImage<'T>
Scaled(xScaleFactor, yScaleFactor, ip)
Signature: (xScaleFactor:float * yScaleFactor:float * ip:ImageInterpolation) -> PixImage<'T>
ScaledPixImage(scaleFactor, ip)
Signature: (scaleFactor:V2d * ip:ImageInterpolation) -> PixImage
Modifiers: abstract
Set(x, y, img)
Signature: (x:int * y:int * img:PixImage<'T>) -> unit

Set a subregion of the image to the contents of another image. The size of the subregion is determined by the other image.

Set(pos, image)
Signature: (pos:V2i * image:PixImage<'T>) -> unit

Set a subregion of the image to the contents of another image. The size of the subregion is dtermined by the other image.

Set(image)
Signature: image:PixImage<'T> -> unit

Set the image contents of the image to the contents of another image. The sizes of the image and the other image have to match.

SetResized(image, ip)
Signature: (image:PixImage<'T> * ip:ImageInterpolation) -> unit

Set the image contents of the image to the contents of another image. The contents of the other image are resized to match.

Size
Signature: V2i
Modifiers: abstract
SizeL
Signature: V2l
Modifiers: abstract
SubImage(x, y, xSize, ySize)
Signature: (x:int64 * y:int64 * xSize:int64 * ySize:int64) -> PixImage<'T>

Returns a specified region as new PixImage. No data is copied, the internal Volumue is only a view on the original one.

SubImage(pos, size)
Signature: (pos:V2i * size:V2i) -> PixImage<'T>

Returns a specified region as new PixImage. No data is copied, the internal Volumue is only a view on the original one.

SubImage(pos, size)
Signature: (pos:V2l * size:V2l) -> PixImage<'T>

Returns a specified region as new PixImage. No data is copied, the internal Volumue is only a view on the original one.

SubImage(box)
Signature: box:Box2i -> PixImage<'T>

Returns a specified region as new PixImage. No data is copied, the internal Volumue is only a view on the original one.

SubImage(center, squareRadius)
Signature: (center:V2i * squareRadius:int) -> PixImage<'T>

Returns a square region around the center as new PixImage. SquareRadius is the given radius around the center. No data is copied, the internal Volumue is only a view on the original one.

SubImage(pos, size)
Signature: (pos:V2d * size:V2d) -> PixImage<'T>

Returns a specified region as a new PixImage. The supplied pos and size are rounded to the nearest integer. Note that this may be different from SubImage(Box2d box), since rounding the size and rounding the Max of the box may result in different integer sizes. No data is copied, the internal Volumue is only a view on the original one.

SubImage(box)
Signature: box:Box2d -> PixImage<'T>

Returns a specified region as a new PixImage. Min and Max of the supplied box are rounded to the nearest integer. Note that this may be different from SubImage(V2d pos, V2d size), since rounding the Max of the box and rounding the size may result in different integer sizes. No data is copied, the internal Volumue is only a view on the original one.

SubImage01(pos, size)
Signature: (pos:V2d * size:V2d) -> PixImage<'T>

Coords in normalized [0, 1] coords of 'this'. The supplied pos and size are converted to pixel coordinates and rounded to the nearest integer. Note that this may be different from SubImage01(Box2d box) since rounding the size and rounding the Max of the box may result in different integer sizes. No data is copied, the internal Volumue is only a view on the original one.

SubImage01(bounds)
Signature: bounds:Box2d -> PixImage<'T>

Coords in normalized [0, 1] coords of 'this'. Min and Max of the supplied box are converted to pixel coordinates and rounded to the nearest integer. Note that this may be different from SubImage01(V2d pos, V2d size), since rounding the Max of the box and rounding the size may result in different integer sizes. No data is copied, the internal Volumue is only a view on the original one.

ToCanonicalDenseLayout()
Signature: unit -> PixImage
Modifiers: abstract
ToFormat(format)
Signature: format:Format -> PixImage<'T>
ToImageLayout()
Signature: unit -> PixImage<'T>
ToPixImage()
Signature: unit -> PixImage<'T1>
Modifiers: abstract
ToPixImage(format)
Signature: format:Format -> PixImage
Modifiers: abstract
Transformed(trafo)
Signature: trafo:ImageTrafo -> PixImage
Modifiers: abstract
Visit(visitor)
Signature: visitor:IPixImageVisitor<'TResult> -> 'TResult
Modifiers: abstract
VolumeInfo
Signature: VolumeInfo
Modifiers: abstract

Static members

Static memberDescription
Create(channels)
Signature: (channels:Matrix<'T> []) -> PixImage<'T>
Create(format, channels)
Signature: (format:Format * channels:Matrix<'T> []) -> PixImage<'T>

Create a pixel image from all the given channels in the specified format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha). the color formatchannel matrices

Create(format, channels)
Signature: (format:Format * channels:Matrix<'Td,'T> []) -> PixImage<'T>

Create a pixel image from all the given channels in the specified format. Note, that the channels have to be supplied in the canonical order: red, green, blue, (alpha).

SetRemappedFun(remappedFun)
Signature: remappedFun:Func<Volume<'T>,Matrix<float32>,Matrix<float32>,ImageInterpolation,Volume<'T>> -> unit
SetRotatedFun(rotatedFun)
Signature: rotatedFun:Func<Volume<'T>,float,bool,ImageInterpolation,Volume<'T>> -> unit
SetScaledFun(scaledFun)
Signature: scaledFun:Func<Volume<'T>,V2d,ImageInterpolation,Volume<'T>> -> unit
Fork me on GitHub