antsImage-class: Class '"antsImage"'

In klshrinidhi/ANTsR: ANTs <--> R

Description

Encapsultates the external pointer to the underlying image along with details used to identify the 'type' of the image on C++ side.

Objects from the Class

Objects can be created by calls of the form new("antsImage", pixeltype, dimension). Image created this way will have invalid external pointer in the slot 'pointer' right after construction. At this point the image is considered 'empty'. This kind of construction is used to create a buffer to hold the result of a function like 'ThresholdImage'. After a successful function call like this, the image will become a valid object that can be used, for example to query a 'region'.

Slots

pixeltype:

Object of class "character". C++ datatype used to represent the pixels in the image. Allowed values: "double", "float", "unsigned int", "unsigned char".

dimension:

Object of class "integer". Number of dimensions of the image. Allowed values: 4, 3, 2

pointer:

Object of class "externalptr". External pointer to the actual image in the memory. User should not set or manipulate it at any point.

Methods

antsSetInput

signature(filter = "antsBinaryThresholdImageFilter", image = "antsImage"): Specify an antsImage as input to the filter

antsSetInput

signature(filter = "antsPermuteAxesImageFilter", image = "antsImage"): Specify an antsImage as input to the filter

antsSetInput

signature(filter = "antsThresholdImageFilter", image = "antsImage"): Specify an antsImage as input to the filter

as.array

signature(x = "antsImage"): Convert/coerce an antsImage into an array. Original antsImage object is not modified

as.matrix

signature(x = "antsImage"): Convert/coerce an antsImage into an matrix. Original antsImage object is not modified

as.numeric

signature(x = "antsImage"): Convert/coerce an antsImage into an numeric vector. Original antsImage object is not modified

<=

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

<

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

==

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

>=

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

>

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

!=

signature(e1 = "antsImage", e2 = "ANY"): Pixelwise comparison optionally within an given region of antsImage.

[

signature(x = "antsImage", i = "array", j = "antsRegion"): Get an array of pixels within a given antsRegion using a logical array as index

[

signature(x = "antsImage", i = "array", j = "ANY"): Get an array of pixels within the antsImage using a logical array as index

[

signature(x = "antsImage", i = "list", j = "ANY"): Get an array of pixels within a given antsRegion( supplied at i$region ) using a logical array( supplied as i$mask ) as index.

[

signature(x = "antsImage", i = "logical", j = "antsRegion"): Get an array of pixels within the antsRegion using a logical vector as index

[

signature(x = "antsImage", i = "logical", j = "ANY"): Get an array of pixels within the antsImage using a logical vector as index

[

signature(x = "antsImage", i = "matrix", j = "antsRegion"): Get an array of pixels within a given antsRegion using a logical matrix as index

[

signature(x = "antsImage", i = "matrix", j = "ANY"): Get an array of pixels within the antsImage using a logical matrix as index

[

signature(x = "antsImage", i = "NULL", j = "NULL"): Get a numeric vector of pixels using given index vectors

[

signature(x = "antsImage", i = "NULL", j = "numeric"): Get a numeric vector of pixels using given index vectors

[

signature(x = "antsImage", i = "numeric", j = "NULL"): Get a numeric vector of pixels using given index vectors

[

signature(x = "antsImage", i = "numeric", j = "numeric"): Get a numeric vector of pixels using given index vectors

[<-

signature(x = "antsImage", i = "array", j = "antsRegion", value = "ANY"): Set an array of pixels within an antsRegion using a logical array as index

[<-

signature(x = "antsImage", i = "array", j = "ANY", value = "ANY"): Set an array of pixels within an antsImage using a logical array as index

[<-

signature(x = "antsImage", i = "list", j = "ANY", value = "ANY"): Set an array of pixels within an antsRegion( specified by i$region ) using a logical array( specified by i$mask ) as index

[<-

signature(x = "antsImage", i = "logical", j = "antsRegion", value = "ANY"): Set an array of pixels within an antsRegion using a logical vector as index

[<-

signature(x = "antsImage", i = "logical", j = "ANY", value = "ANY"): Set an array of pixels within an antsImage using a logical vector as index

[<-

signature(x = "antsImage", i = "matrix", j = "antsRegion", value = "ANY"): Set an array of pixels within an antsRegion using a logical matrix as index

[<-

signature(x = "antsImage", i = "matrix", j = "ANY", value = "ANY"): Set an array of pixels within an antsImage using a logical matrix as index

[<-

signature(x = "antsImage", i = "NULL", j = "NULL", value = "numeric"): Set a numeric vector of pixels using given index vectors

[<-

signature(x = "antsImage", i = "NULL", j = "numeric", value = "numeric"): Set a numeric vector of pixels using given index vectors

[<-

signature(x = "antsImage", i = "numeric", j = "NULL", value = "numeric"): Set a numeric vector of pixels using given index vectors

[<-

signature(x = "antsImage", i = "numeric", j = "numeric", value = "numeric"): Set a numeric vector of pixels using given index vectors

Author(s)

Shrinidhi KL

Examples

showClass("antsImage")

klshrinidhi/ANTsR documentation built on May 20, 2019, 12:37 p.m.