wavefrontshaping / pymmf
Test mode computation in multimode fibers
Run wavefrontshaping/pymmf with an API
Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.
Input schema
The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.
| Field | Type | Default value | Description |
|---|---|---|---|
| profile_type |
string
(enum)
|
GRIN
Options: GRIN, SI |
Index profile (Graded index or step-index)
|
| wl |
number
|
1550
Min: 100 Max: 2000 |
Wavelength (in nm).
|
| core_diam |
number
|
50
Min: 10 Max: 80 |
Core diameter (in microns).
|
| n_cladding |
number
|
1.45
Min: 1.3 Max: 1.6 |
Refractive index of the cladding.
|
| NA |
number
|
0.2
Min: 0.05 Max: 0.5 |
Core diameter (in microns).
|
| mode_repr |
string
(enum)
|
cos
Options: cos, exp |
Mode representation, 'cos' for LP modes, 'exp' for OAM modes (if no curvature).
|
| is_curvature |
string
(enum)
|
No
Options: Yes, No |
Curvature. Select 'No' for a straight fiber. Expect much longer computation time with curvature.
|
| curvature_x |
number
|
10
Min: 1 Max: 200 |
Curvature (in mm)
|
{
"type": "object",
"title": "Input",
"properties": {
"NA": {
"type": "number",
"title": "Na",
"default": 0.2,
"maximum": 0.5,
"minimum": 0.05,
"x-order": 4,
"description": "Core diameter (in microns)."
},
"wl": {
"type": "number",
"title": "Wl",
"default": 1550,
"maximum": 2000,
"minimum": 100,
"x-order": 1,
"description": "Wavelength (in nm)."
},
"core_diam": {
"type": "number",
"title": "Core Diam",
"default": 50,
"maximum": 80,
"minimum": 10,
"x-order": 2,
"description": "Core diameter (in microns)."
},
"mode_repr": {
"enum": [
"cos",
"exp"
],
"type": "string",
"title": "mode_repr",
"description": "Mode representation, 'cos' for LP modes, 'exp' for OAM modes (if no curvature).",
"default": "cos",
"x-order": 5
},
"n_cladding": {
"type": "number",
"title": "N Cladding",
"default": 1.45,
"maximum": 1.6,
"minimum": 1.3,
"x-order": 3,
"description": "Refractive index of the cladding."
},
"curvature_x": {
"type": "number",
"title": "Curvature X",
"default": 10,
"maximum": 200,
"minimum": 1,
"x-order": 7,
"description": "Curvature (in mm)"
},
"is_curvature": {
"enum": [
"Yes",
"No"
],
"type": "string",
"title": "is_curvature",
"description": "Curvature. Select 'No' for a straight fiber. Expect much longer computation time with curvature.",
"default": "No",
"x-order": 6
},
"profile_type": {
"enum": [
"GRIN",
"SI"
],
"type": "string",
"title": "profile_type",
"description": "Index profile (Graded index or step-index)",
"default": "GRIN",
"x-order": 0
}
}
}
Output schema
The shape of the response you’ll get when you run this model with an API.
{
"type": "array",
"items": {
"type": "string",
"format": "uri"
},
"title": "Output"
}