Class NPPImageBase

Abstract base class for derived NPP typed images.

Inheritance
System.Object
NPPImageBase
NPPImage_16sC1
NPPImage_16sC2
NPPImage_16sC3
NPPImage_16sC4
NPPImage_16scC1
NPPImage_16scC2
NPPImage_16scC3
NPPImage_16scC4
NPPImage_16uC1
NPPImage_16uC2
NPPImage_16uC3
NPPImage_16uC4
NPPImage_32fC1
NPPImage_32fC3
NPPImage_32fC4
NPPImage_32fcC1
NPPImage_32fcC2
NPPImage_32fcC3
NPPImage_32fcC4
NPPImage_32sC1
NPPImage_32sC3
NPPImage_32sC4
NPPImage_32scC1
NPPImage_32scC2
NPPImage_32scC3
NPPImage_32scC4
NPPImage_32uC1
NPPImage_32uC4
NPPImage_8sC1
NPPImage_8sC2
NPPImage_8sC3
NPPImage_8sC4
NPPImage_8uC1
NPPImage_8uC2
NPPImage_8uC3
NPPImage_8uC4
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ManagedCuda.NPP
Assembly: NPP.dll
Syntax
public abstract class NPPImageBase : IDisposable

Fields

| Improve this Doc View Source

_channels

Number of color channels in image.

Declaration
protected int _channels
Field Value
Type Description
System.Int32
| Improve this Doc View Source

_devPtr

Base pointer to image data.

Declaration
protected CUdeviceptr _devPtr
Field Value
Type Description
CUdeviceptr
| Improve this Doc View Source

_devPtrRoi

Base pointer moved to actual ROI.

Declaration
protected CUdeviceptr _devPtrRoi
Field Value
Type Description
CUdeviceptr
| Improve this Doc View Source

_isOwner

Declaration
protected bool _isOwner
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

_pitch

Width of one image line + alignment bytes.

Declaration
protected int _pitch
Field Value
Type Description
System.Int32
| Improve this Doc View Source

_pointRoi

First pixel in the ROI.

Declaration
protected NppiPoint _pointRoi
Field Value
Type Description
NppiPoint
| Improve this Doc View Source

_sizeOriginal

Size of the entire image.

Declaration
protected NppiSize _sizeOriginal
Field Value
Type Description
NppiSize
| Improve this Doc View Source

_sizeRoi

Size of the actual ROI.

Declaration
protected NppiSize _sizeRoi
Field Value
Type Description
NppiSize
| Improve this Doc View Source

_typeSize

Type size in bytes of one pixel in one channel.

Declaration
protected int _typeSize
Field Value
Type Description
System.Int32
| Improve this Doc View Source

disposed

Declaration
protected bool disposed
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

res

Last CUResult.

Declaration
protected CUResult res
Field Value
Type Description
CUResult
| Improve this Doc View Source

status

Last NPPStatus result.

Declaration
protected NppStatus status
Field Value
Type Description
NppStatus

Properties

| Improve this Doc View Source

Channels

Color channels

Declaration
public int Channels { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DevicePointer

Device pointer to image data.

Declaration
public CUdeviceptr DevicePointer { get; }
Property Value
Type Description
CUdeviceptr
| Improve this Doc View Source

DevicePointerRoi

Device pointer to first pixel in ROI.

Declaration
public CUdeviceptr DevicePointerRoi { get; }
Property Value
Type Description
CUdeviceptr
| Improve this Doc View Source

Height

Height in pixels

Declaration
public int Height { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

HeightRoi

Height in pixels

Declaration
public int HeightRoi { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Pitch

Pitch in bytes

Declaration
public int Pitch { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PointRoi

First pixel in the ROI.

Declaration
public NppiPoint PointRoi { get; }
Property Value
Type Description
NppiPoint
| Improve this Doc View Source

Size

Size of the entire image.

Declaration
public NppiSize Size { get; }
Property Value
Type Description
NppiSize
| Improve this Doc View Source

SizeRoi

Size of the actual ROI.

Declaration
public NppiSize SizeRoi { get; }
Property Value
Type Description
NppiSize
| Improve this Doc View Source

TotalSizeInBytes

Total size in bytes (Pitch * Height)

Declaration
public int TotalSizeInBytes { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Width

Width in pixels

Declaration
public int Width { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

WidthInBytes

Width in bytes

Declaration
public int WidthInBytes { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

WidthRoi

Width in pixels

Declaration
public int WidthRoi { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

WidthRoiInBytes

Width in bytes

Declaration
public int WidthRoiInBytes { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

AsyncCopyToDevice(CUdeviceptr, CUstream)

Async Copy data from device to device memory

Declaration
public void AsyncCopyToDevice(CUdeviceptr source, CUstream stream)
Parameters
Type Name Description
CUdeviceptr source

Source pointer to device memory
CUstream stream
| Improve this Doc View Source

AsyncCopyToDevice(NPPImageBase, CUstream)

Async Copy from device to device memory

Declaration
public void AsyncCopyToDevice(NPPImageBase deviceSrc, CUstream stream)
Parameters
Type Name Description
NPPImageBase deviceSrc

Source
CUstream stream
| Improve this Doc View Source

AsyncCopyToDevice<T>(CudaDeviceVariable<T>, CUstream)

Async Copy data from device to device memory

Declaration
public void AsyncCopyToDevice<T>(CudaDeviceVariable<T> source, CUstream stream)
    where T : struct
Parameters
Type Name Description
CudaDeviceVariable<T> source

Source
CUstream stream
Type Parameters
Name Description
T
| Improve this Doc View Source

AsyncCopyToDevice<T>(CudaPitchedDeviceVariable<T>, CUstream)

Async Copy from device to device memory

Declaration
public void AsyncCopyToDevice<T>(CudaPitchedDeviceVariable<T> deviceSrc, CUstream stream)
    where T : struct
Parameters
Type Name Description
CudaPitchedDeviceVariable<T> deviceSrc

Source
CUstream stream
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToDevice(CUdeviceptr)

Copy from device to device memory

Declaration
public void CopyToDevice(CUdeviceptr deviceSrc)
Parameters
Type Name Description
CUdeviceptr deviceSrc

Source
| Improve this Doc View Source

CopyToDevice(CUdeviceptr, SizeT)

Copy from device to device memory

Declaration
public void CopyToDevice(CUdeviceptr deviceSrc, SizeT pitch)
Parameters
Type Name Description
CUdeviceptr deviceSrc

Source
SizeT pitch

Pitch of deviceSrc
| Improve this Doc View Source

CopyToDevice(NPPImageBase)

Copy from device to device memory

Declaration
public void CopyToDevice(NPPImageBase deviceSrc)
Parameters
Type Name Description
NPPImageBase deviceSrc

Source
| Improve this Doc View Source

CopyToDevice(Array)

Copy from Host to device memory

Declaration
public void CopyToDevice(Array hostSrc)
Parameters
Type Name Description
System.Array hostSrc

Source
| Improve this Doc View Source

CopyToDevice(Array, SizeT)

Copy from Host to device memory

Declaration
public void CopyToDevice(Array hostSrc, SizeT stride)
Parameters
Type Name Description
System.Array hostSrc

Source
SizeT stride

Size of one image line in bytes with padding
| Improve this Doc View Source

CopyToDevice(Bitmap)

Copy data from a System.Drawing.Bitmap. There is no check if the bitmap pixel type corresponds to the current NPPImage!

Declaration
public void CopyToDevice(Bitmap bitmap)
Parameters
Type Name Description
System.Drawing.Bitmap bitmap
| Improve this Doc View Source

CopyToDevice(IntPtr)

Copy from Host to device memory

Declaration
public void CopyToDevice(IntPtr hostSrc)
Parameters
Type Name Description
System.IntPtr hostSrc

Source
| Improve this Doc View Source

CopyToDevice(IntPtr, SizeT)

Copy from Host to device memory

Declaration
public void CopyToDevice(IntPtr hostSrc, SizeT stride)
Parameters
Type Name Description
System.IntPtr hostSrc

Source
SizeT stride

Size of one image line in bytes with padding
| Improve this Doc View Source

CopyToDevice<T>(CudaDeviceVariable<T>)

Copy from device to device memory

Declaration
public void CopyToDevice<T>(CudaDeviceVariable<T> deviceSrc)
    where T : struct
Parameters
Type Name Description
CudaDeviceVariable<T> deviceSrc

Source
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToDevice<T>(CudaPitchedDeviceVariable<T>)

Copy from device to device memory

Declaration
public void CopyToDevice<T>(CudaPitchedDeviceVariable<T> deviceSrc)
    where T : struct
Parameters
Type Name Description
CudaPitchedDeviceVariable<T> deviceSrc

Source
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToDeviceRoi(CUdeviceptr, SizeT, NppiRect)

Copy from device to device memory

Declaration
public void CopyToDeviceRoi(CUdeviceptr deviceSrc, SizeT pitch, NppiRect roi)
Parameters
Type Name Description
CUdeviceptr deviceSrc

Source
SizeT pitch

Pitch of deviceSrc
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(CUdeviceptr, NppiRect)

Copy from device to device memory

Declaration
public void CopyToDeviceRoi(CUdeviceptr deviceSrc, NppiRect roi)
Parameters
Type Name Description
CUdeviceptr deviceSrc

Source
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(NPPImageBase)

Copy from device to device memory

Declaration
public void CopyToDeviceRoi(NPPImageBase deviceSrc)
Parameters
Type Name Description
NPPImageBase deviceSrc

Source
| Improve this Doc View Source

CopyToDeviceRoi(Array, SizeT, NppiRect)

Copy from Host to device memory

Declaration
public void CopyToDeviceRoi(Array hostSrc, SizeT stride, NppiRect roi)
Parameters
Type Name Description
System.Array hostSrc

Source
SizeT stride

Size of one image line in bytes with padding
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(Array, NppiRect)

Copy from Host to device memory

Declaration
public void CopyToDeviceRoi(Array hostSrc, NppiRect roi)
Parameters
Type Name Description
System.Array hostSrc

Source
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(Bitmap, NppiRect)

Copy data from a System.Drawing.Bitmap. There is no check if the bitmap pixel type corresponds to the current NPPImage!

Declaration
public void CopyToDeviceRoi(Bitmap bitmap, NppiRect roi)
Parameters
Type Name Description
System.Drawing.Bitmap bitmap

Source Bitmap
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(IntPtr, SizeT, NppiRect)

Copy from Host to device memory

Declaration
public void CopyToDeviceRoi(IntPtr hostSrc, SizeT stride, NppiRect roi)
Parameters
Type Name Description
System.IntPtr hostSrc

Source
SizeT stride

Size of one image line in bytes with padding
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi(IntPtr, NppiRect)

Copy from Host to device memory

Declaration
public void CopyToDeviceRoi(IntPtr hostSrc, NppiRect roi)
Parameters
Type Name Description
System.IntPtr hostSrc

Source
NppiRect roi

ROI of source image
| Improve this Doc View Source

CopyToDeviceRoi<T>(CudaDeviceVariable<T>, NppiRect)

Copy from device to device memory

Declaration
public void CopyToDeviceRoi<T>(CudaDeviceVariable<T> deviceSrc, NppiRect roi)
    where T : struct
Parameters
Type Name Description
CudaDeviceVariable<T> deviceSrc

Source
NppiRect roi

ROI of source image
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToDeviceRoi<T>(CudaPitchedDeviceVariable<T>, NppiRect)

Copy from device to device memory

Declaration
public void CopyToDeviceRoi<T>(CudaPitchedDeviceVariable<T> deviceSrc, NppiRect roi)
    where T : struct
Parameters
Type Name Description
CudaPitchedDeviceVariable<T> deviceSrc

Source
NppiRect roi

ROI of source image
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToHost(Array, SizeT)

Copy data from this device to host memory

Declaration
public void CopyToHost(Array hostDest, SizeT stride)
Parameters
Type Name Description
System.Array hostDest

Destination
SizeT stride

Size of one image line in bytes with padding
| Improve this Doc View Source

CopyToHost(Bitmap)

Copy data to a System.Drawing.Bitmap. There is no check if the bitmap pixel type corresponds to the current NPPImage!

Declaration
public void CopyToHost(Bitmap bitmap)
Parameters
Type Name Description
System.Drawing.Bitmap bitmap
| Improve this Doc View Source

CopyToHost(IntPtr)

Copy data from device to host memory

Declaration
public void CopyToHost(IntPtr hostDest)
Parameters
Type Name Description
System.IntPtr hostDest

IntPtr to destination in host memory
| Improve this Doc View Source

CopyToHost(IntPtr, SizeT)

Copy data from device to host memory

Declaration
public void CopyToHost(IntPtr hostDest, SizeT stride)
Parameters
Type Name Description
System.IntPtr hostDest

IntPtr to destination in host memory
SizeT stride

Size of one image line in bytes with padding
| Improve this Doc View Source

CopyToHost<T>(T[])

Copy data from device to host memory

Declaration
public void CopyToHost<T>(T[] aHostDest)
    where T : struct
Parameters
Type Name Description
T[] aHostDest

Destination
Type Parameters
Name Description
T
| Improve this Doc View Source

CopyToHostRoi(Array, SizeT, NppiRect)

Copy data from this device to host memory

Declaration
public void CopyToHostRoi(Array hostDest, SizeT stride, NppiRect roi)
Parameters
Type Name Description
System.Array hostDest

Destination
SizeT stride

Size of one image line in bytes with padding
NppiRect roi

ROI of destination image
| Improve this Doc View Source

CopyToHostRoi(Bitmap, NppiRect)

Copy data to a System.Drawing.Bitmap. There is no check if the bitmap pixel type corresponds to the current NPPImage!

Declaration
public void CopyToHostRoi(Bitmap bitmap, NppiRect roi)
Parameters
Type Name Description
System.Drawing.Bitmap bitmap

Destination Bitmap
NppiRect roi

ROI of destination image
| Improve this Doc View Source

CopyToHostRoi(IntPtr, SizeT, NppiRect)

Copy data from device to host memory

Declaration
public void CopyToHostRoi(IntPtr hostDest, SizeT stride, NppiRect roi)
Parameters
Type Name Description
System.IntPtr hostDest

IntPtr to destination in host memory
SizeT stride

Size of one image line in bytes with padding
NppiRect roi

ROI of destination image
| Improve this Doc View Source

CopyToHostRoi(IntPtr, NppiRect)

Copy data from device to host memory

Declaration
public void CopyToHostRoi(IntPtr hostDest, NppiRect roi)
Parameters
Type Name Description
System.IntPtr hostDest

IntPtr to destination in host memory
NppiRect roi

ROI of destination image
| Improve this Doc View Source

CopyToHostRoi<T>(T[], NppiRect)

Copy data from device to host memory

Declaration
public void CopyToHostRoi<T>(T[] aHostDest, NppiRect roi)
    where T : struct
Parameters
Type Name Description
T[] aHostDest

Destination
NppiRect roi

ROI of destination image
Type Parameters
Name Description
T
| Improve this Doc View Source

Dispose()

Dispose

Declaration
public virtual void Dispose()
| Improve this Doc View Source

Dispose(Boolean)

For IDisposable

Declaration
protected virtual void Dispose(bool fDisposing)
Parameters
Type Name Description
System.Boolean fDisposing
| Improve this Doc View Source

GetResizeRect(Double, Double, Double, Double, InterpolationMode)

Returns NppiRect which represents the offset and size of the destination rectangle that would be generated by resizing the source NppiRect by the requested scale factors and shifts.

Declaration
public NppiRect GetResizeRect(double nXFactor, double nYFactor, double nXShift, double nYShift, InterpolationMode eInterpolation)
Parameters
Type Name Description
System.Double nXFactor

Factor by which x dimension is changed.
System.Double nYFactor

Factor by which y dimension is changed.
System.Double nXShift

Source pixel shift in x-direction.
System.Double nYShift

Source pixel shift in y-direction.
InterpolationMode eInterpolation

The type of eInterpolation to perform resampling.
Returns
Type Description
NppiRect
| Improve this Doc View Source

ResetRoi()

Resets the ROI to the full image

Declaration
public void ResetRoi()
| Improve this Doc View Source

SetRoi(NppiRect)

Defines the ROI on which all following operations take place

Declaration
public void SetRoi(NppiRect roi)
Parameters
Type Name Description
NppiRect roi
| Improve this Doc View Source

SetRoi(Int32, Int32, Int32, Int32)

Defines the ROI on which all following operations take place

Declaration
public void SetRoi(int x, int y, int width, int height)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height

Implements

System.IDisposable