| LTPDA Toolbox™ | contents | ![]() |
SCALE scales the data in the AO by the specified factor. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% DESCRIPTION: SCALE scales the data in the AO by the specified factor. CALL: bs = scale(a1,a2,a3,...,pl) bs = scale(as,pl) bs = as.scale(pl) INPUTS: aN - input analysis objects as - input analysis objects array pl - input parameter list OUTPUTS: bs - array of analysis objects, one for each input Parameters Description %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
| Method Details | |
|---|---|
| Access | public |
| Defining Class | ao |
| Sealed | 0 |
| Static | 0 |
| Sets for this method … |
|---|
| Default |
Default |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| scale | |||
| FACTOR | 1 | none | The factor to scale by. It can be a double or an ao. In this latter case, the units will be multiplied as well |
| OFFSET | 0 | none | An offset to add to the scaled AO. It can be a double or an ao. In this latter case, the units must match the scaled AO |
| YUNITS | '' | none | Set a value for the scale factor units; empty => output object will have the same units as input. Note: these units will override those from the scale factor, if the user specified it as an ao! |
| XUNITS | '' | none | Set a value for the scale factor units; empty => output object will have the same units as input. Note: these units will override those from the scale factor, if the user specified it as an ao! |
| TARGET UNITS, OUTPUT UNITS | [] | none | The target units to scale the objects for. If these are set, the 'factor' will be ignored and the data will be scaled accordingly. |
| AXIS | 'y' |
|
The axis on which to apply the method. |
Example |
|---|
| plist('FACTOR', [1], 'OFFSET', [0], 'YUNITS', '', 'XUNITS', '', 'TARGET UNITS', [[]], 'AXIS', 'y') |
back to top
| Some information of the method ao/scale are listed below: | |
|---|---|
| Class name | ao |
| Method name | scale |
| Category | Operator |
| Package name | ltpda |
| Can be used as modifier | 1 |
| Supported numeric types | {'double'} |
|
Method: ao/round | Method: ao/sign | ![]() |
©LTP Team