<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

itools/

mgitopadapthistequal__define.pro

Last modification:
Sat Apr 29 21:52:45 2006
This subclass of IDLitDataOperation, implements the AdaptHistEqual operation for the itools system. IDLitDataOperation is subclassed because this operation doesn't need the flexibility of IDLitOperation, it simply operates on the data of the currently item.

Routine summary

mgitopadapthistequal::getProperty[, clip=variable][, nregions=variable][, top=variable][, _ref_extra=variable]

Get properties of the operation.

mgitopadapthistequal::setProperty[, clip=float][, nregions=long][, top=byte][, _ref_extra=keywords]

Set properties of the operation.

result = mgitopadapthistequal::doExecuteUI()

This method is called to present a GUI for the user to modify properties, see a preview, etc.

result = mgitopadapthistequal::execute(data)

This is the method that actually does the operation.

mgitopadapthistequal::cleanup

Free resources of the object.

result = mgitopadapthistequal::init([_ref_extra=keywords])

Jobs for the init method: 1) call the parent's init method (you MUST pass along keyword via _EXTRA) 2) initialize member variables (properties of the operation) 3) register properties

mgitopadapthistequal__define

Define the member variables of the objects of the class.

topmgitopadapthistequal::getProperty

mgitopadapthistequal::getProperty[, clip=variable][, nregions=variable][, top=variable][, _ref_extra=variable]

Get properties of the operation. The itools must be able to get properties of your operation (and parents' properties), so be sure to pass along keywords to IDLitDataOperation::getProperty.

Keywords

clip        out optional type: float

slope limit of histogram

nregions        out optional type: long

size of the overlapped tiles as a fraction image size

top        out optional type: byte

maximum value of the scaled output array

_ref_extra        out optional type: keywords

keywords of IDLitDataOperation

Statistics

McCabe cyclic 5
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal::setProperty

mgitopadapthistequal::setProperty[, clip=float][, nregions=long][, top=byte][, _ref_extra=keywords]

Set properties of the operation. The itools must be able to set properties of your operation (and parents' properties), so be sure to pass along keywords to IDLitDataOperation::setProperty.

Keywords

clip        in optional type: float

slope limit of histogram

nregions        in optional type: long

size of the overlapped tiles as a fraction image size

top        in optional type: byte

maximum value of the scaled output array

_ref_extra        in optional type: keywords

keywords of IDLitDataOperation

Statistics

McCabe cyclic 5
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal::doExecuteUI

result = mgitopadapthistequal::doExecuteUI()

This method is called to present a GUI for the user to modify properties, see a preview, etc. before the operation is executed.

Return value

1 for success, 0 for failure

Statistics

McCabe cyclic 2
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal::execute

result = mgitopadapthistequal::execute(data)

This is the method that actually does the operation.

Return value

1 for success, 0 for failure.

Parameters

data        in out required type: 2D array

modify this variable to do the operation; it's a 2D array because of the TYPES keyword in the call to IDLitDataOperation::init.

Statistics

McCabe cyclic 1
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal::cleanup

mgitopadapthistequal::cleanup

Free resources of the object.

Statistics

McCabe cyclic 1
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal::init

result = mgitopadapthistequal::init([_ref_extra=keywords])

Jobs for the init method: 1) call the parent's init method (you MUST pass along keyword via _EXTRA) 2) initialize member variables (properties of the operation) 3) register properties

Return value

1L if successful, 0L otherwise

Keywords

_ref_extra        in optional type: keywords

keywords to IDLitDataOperation::init

Statistics

McCabe cyclic 2
McCabe essential 1
McCabe modular design 1

topmgitopadapthistequal__define

mgitopadapthistequal__define

Define the member variables of the objects of the class. The registered properties will be among these.

Statistics

McCabe cyclic 1
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0 on Wed Apr 25 22:45:38 2007.