-
Notifications
You must be signed in to change notification settings - Fork 0
Forward Solver Endpoint
Lisa Malenfant edited this page May 16, 2020
·
7 revisions
/api/v1/forward
| Property | Type | Values | Required | Description |
|---|---|---|---|---|
| ForwardSolverType | string | PointSourceSDA | yes | Standard Diffusion Approximation (SDA) with point source forward solver |
| DistributedPointSourceSDA | Standard Diffusion Approximation (SDA) with distributed point source forward solver | |||
| DistributedGaussianSourceSDA | Standard Diffusion Approximation (SDA) with Gaussian distributed source forward solver | |||
| DeltaPOne | Delta-P1 forward solver | |||
| MonteCarlo | Scaled Monte Carlo forward solver | |||
| Nurbs | Scaled Monte Carlo forward solver with non-uniform rational b-splines forward solver | |||
| TwoLayerSDA | Two-layer forward solver based on standard diffusion | |||
| SolutionDomain | string | ROfRho | yes | Reflectance as a function of source-detector separation (rho) |
| ROfFx | Reflectance as a function of spatial-frequency (fx) | |||
| ROfRhoAndTime | Reflectance as a function of source-detector separation (rho) and time (t) | |||
| ROfFxAndTime | Reflectance as a function of spatial-frequency (fx) and time (t) | |||
| ROfRhoAndFt | Reflectance as a function source-detector separation (rho) and temporal-frequency (ft) | |||
| ROfFxAndFt | Reflectance as a function of spatial-frequency (fx) and temporal-frequency (ft) | |||
| XAxis* | object | Object |
yes | |
| IndependentAxis* | object | Object |
yes | required when 2 axes are present |
| SecondIndependentAxis* | object | Object |
no | |
| WavelengthOpticalPropertyList* | array | Array<OpticalProperties> |
no | |
| OpticalProperties* | object | Object |
yes | not required when using wavelength |
| ModelAnalysis | string | R | yes | Reflectance forward analysis type |
| dRdMua | Derivative of reflectance (R) with respect to absorption coefficient (mua) | |||
| dRdMusp | Derivative of reflectance (R) with respect to reduced scattering coefficient (musp) | |||
| dRdG | Derivative of reflectance (R) with respect to anisotropy coefficient (g) | |||
| dRdN | Derivative of reflectance (R) with respect to refractive index (n) | |||
| NoiseValue | double | Any<double> |
no | defaults to 0 |
*Objects defined in detail below
| Property | Type | Values | Required |
|---|---|---|---|
| Axis | string | Any<string> |
yes |
| AxisRange* | double | Object |
yes |
| Property | Type | Values | Required | Description |
|---|---|---|---|---|
| Axis | string | Any<string> |
yes | |
| AxisValue | double | Any<double> |
yes | only required if range is not specified |
| AxisRange* | object | Object |
yes | only required if value is not specified |
| Property | Type | Values | Required |
|---|---|---|---|
| Axis | string | Any<string> |
yes |
| AxisValue | double | Any<double> |
yes |
| Property | Type | Values | Required | Description |
|---|---|---|---|---|
| mua | string | Any<string> |
yes | |
| musp | double | Any<double> |
yes | |
| g | double | Object |
yes | |
| n | double | Object |
yes |
*Object defined in detail below
| Property | Type | Values | Required |
|---|---|---|---|
| Start | double | Any<double> |
yes |
| Stop | double | Any<double> |
yes |
| Count | double | Any<double> |
yes |
{
"forwardSolverType": "PointSourceSDA",
"solutionDomain": "ROfFxAndTime",
"xAxis": {
"axis": "time",
"axisRange": {
"start": 0.001,
"stop": 0.05,
"count": 51
}
},
"independentAxis": {
"axis": "fx",
"axisRange": {
"start": 0,
"stop": 0.5,
"count": 11
}
},
"opticalProperties": {
"mua": 0.06,
"musp": 1.06,
"g": 0.8,
"n": 1.4
},
"modelAnalysis": "R",
"noiseValue": "0"
}