JSON Documentation

https://spekpy.smile.ki.se/api/
Admin
This project provides documentation related to JSON, including its structure, usage, and related...
Tokens:7,285
Snippets:54
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### GET /api/target-materials/{physics_model}/

Source: https://spekpy.smile.ki.se/api/docs

Retrieves a list of target materials supported by a specific physics model. This is essential for setting up accurate simulations.

```APIDOC
## GET /api/target-materials/{physics_model}/

### Description
Retrieves a list of target materials supported by a specific physics model. This is essential for setting up accurate simulations.

### Method
GET

### Endpoint
/api/target-materials/{physics_model}/

### Parameters
#### Path Parameters
- **physics_model** (string) - Required - The name of the physics model.

### Response
#### Success Response (200)
- **target_materials_response** (SpwTargetMaterialsResponse) - A list of target materials supported by the physics model.

#### Response Example
{
  "target_materials_response": {
    "materials": [
      {
        "name": "Tungsten",
        "density": 19.3,
        "atomic_number": 74
      },
      {
        "name": "Molybdenum",
        "density": 10.22,
        "atomic_number": 42
      }
    ]
  }
}
```

--------------------------------

### GET /api/physics-models/

Source: https://spekpy.smile.ki.se/api/json

Lists all available physics models supported by the SpekPy API. This endpoint is useful for discovering which simulation models can be used.

```APIDOC
## GET /api/physics-models/

### Description
List available physics models.

### Method
GET

### Endpoint
/api/physics-models/

### Response
#### Success Response (200)
- **physics_models** (array) - A list of available physics models.
```

--------------------------------

### GET /api/filtration-materials/

Source: https://spekpy.smile.ki.se/api/docs

Retrieves a list of available filtration materials. This information is useful for configuring spectrum generation and material calculations.

```APIDOC
## GET /api/filtration-materials/

### Description
Retrieves a list of available filtration materials. This information is useful for configuring spectrum generation and material calculations.

### Method
GET

### Endpoint
/api/filtration-materials/

### Response
#### Success Response (200)
- **filtration_materials** (SpwFiltrationMaterialsResponse) - A list of available filtration materials.

#### Response Example
{
  "filtration_materials": [
    {
      "name": "Aluminum",
      "density": 2.7,
      "atomic_number": 13
    },
    {
      "name": "Copper",
      "density": 8.96,
      "atomic_number": 29
    }
  ]
}
```

--------------------------------

### GET /api/physics-models/

Source: https://spekpy.smile.ki.se/api/docs

Retrieves a list of available physics models. Different models may offer varying levels of accuracy or computational complexity.

```APIDOC
## GET /api/physics-models/

### Description
Retrieves a list of available physics models. Different models may offer varying levels of accuracy or computational complexity.

### Method
GET

### Endpoint
/api/physics-models/

### Response
#### Success Response (200)
- **physics_models_response** (SpwPhysicsModelsResponse) - A list of available physics models.

#### Response Example
{
  "physics_models_response": {
    "models": [
      "SpekPy-basic",
      "SpekPy-advanced"
    ]
  }
}
```

--------------------------------

### GET /api/kv-range/{physics_model}/{target_material}/

Source: https://spekpy.smile.ki.se/api/docs

Retrieves the valid kilovoltage peak (kVp) range for a given physics model and target material. This helps in setting appropriate parameters for spectrum generation.

```APIDOC
## GET /api/kv-range/{physics_model}/{target_material}/

### Description
Retrieves the valid kilovoltage peak (kVp) range for a given physics model and target material. This helps in setting appropriate parameters for spectrum generation.

### Method
GET

### Endpoint
/api/kv-range/{physics_model}/{target_material}/

### Parameters
#### Path Parameters
- **physics_model** (string) - Required - The name of the physics model.
- **target_material** (string) - Required - The name of the target material.

### Response
#### Success Response (200)
- **kv_range_response** (SpwKvrangeResponse) - The valid kVp range for the specified model and material.

#### Response Example
{
  "kv_range_response": {
    "min_kvp": 20,
    "max_kvp": 150
  }
}
```

--------------------------------

### Get kV Range for Physics Model and Target Material

Source: https://spekpy.smile.ki.se/api/json

Retrieves the minimum and maximum kV values for a specific combination of physics model and target material.

```APIDOC
## GET /api/kv-range/{physics_model}/{target_material}/

### Description
Get the minimum and maximum kV for a specific combination of physics model and target material.

### Method
GET

### Endpoint
/api/kv-range/{physics_model}/{target_material}/

### Parameters
#### Path Parameters
- **physics_model** (string) - Required - The physics model to use. Allowed values: ["casim", "kqp", "spekpy-v1", "spekcalc"].
- **target_material** (string) - Required - The anode target material. Allowed values: ["W", "Mo", "Rh"].

### Response
#### Success Response (200)
- **min_kv** (number) - The minimum kV for the specified combination.
- **max_kv** (number) - The maximum kV for the specified combination.
```

--------------------------------

### POST /api/calculate-spectrum/

Source: https://spekpy.smile.ki.se/api/docs

Generates a radiation spectrum based on specified parameters. This is fundamental for simulating radiation fields and their interactions.

```APIDOC
## POST /api/calculate-spectrum/

### Description
Generates a radiation spectrum based on specified parameters. This is fundamental for simulating radiation fields and their interactions.

### Method
POST

### Endpoint
/api/calculate-spectrum/

### Parameters
#### Request Body
- **spectrum_request** (SpwSpectrumRequest) - Required - The parameters defining the spectrum to be generated.

### Request Example
{
  "kvp": 100,
  "target_material": {
    "name": "Tungsten",
    "density": 19.3,
    "atomic_number": 74
  },
  "filtration_materials": [
    {
      "name": "Aluminum",
      "density": 2.7,
      "atomic_number": 13,
      "thickness_mm": 1.0
    }
  ],
  "physics_model": "SpekPy-basic"
}

### Response
#### Success Response (200)
- **spectrum_response** (SpwSpectrumResponse) - The generated radiation spectrum.

#### Response Example
{
  "spectrum_response": {
    "energies_kev": [10, 20, 30],
    "intensities": [0.5, 0.3, 0.2]
  }
}
```

--------------------------------

### SpwMaterialThicknessFractionRequest

Source: https://spekpy.smile.ki.se/api/json

Request schema for material thickness fraction, specifying material and its fraction.

```APIDOC
## SpwMaterialThicknessFractionRequest

### Description
This schema is used to request the thickness fraction of a specific material.

### Schema
```json
{
  "fraction": "number",
  "material": "string"
}
```

### Fields
- **fraction** (number) - Optional - Fraction, with a minimum of 0.0 and a maximum of 1.0.
- **material** (string) - Optional - Material. This material name shall be used in the API requests. It must be one of the following: [H, He, Li, Be, B, C, N, O, F, Ne, Na, Mg, Al, Si, P, S, Cl, Ar, K, Ca, Sc, Ti, V, Cr, Mn, Fe, Co, Ni, Cu, Zn, Ga, Ge, As, Se, Br, Kr, Rb, Sr, Y, Zr, Nb, Mo, Tc, Ru, Rh, Pd, Ag, Cd, In, Sn, Sb, Te, I, Xe, Cs, Ba, La, Ce, Pr, Nd, Pm, Sm, Eu, Gd, Tb, Dy, Ho, Er, Tm, Yb, Lu, Hf, Ta, W, Re, Os, Ir, Pt, Au, Hg, Tl, Pb, Bi, Po, At, Rn, Fr, Ra, Ac, Th, Pa, U, 1,2-Dichlorobenzene, 1,2-Dichloroethane, 1,3-Butadiene (Liquid), 1,3-Butadiene, 1-Butene (Liquid), 1-Butene, A-150 Tissue-Equivalent Gas, A-150 Tissue-Equivalent Plastic, Acetone, Acetylene, Adenine, Adipose Tissue (ICRP), Adipose Tissue (ICRU), Adipose Tissue Substitute (AP-L2, Aqueous), Adipose Tissue Substitute (AP-SF1, Epoxy-based), Adipose Tissue Substitute (AP6, Epoxy-based), Air Dry (Near Sea Level), Air, Air-Equivalent Plastic (C-552), Alanine, Aluminum Alloy (Type 1100), Aluminum Alloy (Type 2014), Aluminum Alloy (Type 6061), Aluminum Oxide, Amber, Ammonia, Ammonium Formate, Aniline, Anthracene, Bakelite, Barium Fluoride, Barium Sulfate, Benzene, Beryllium Oxide, Bismuth Germanium Oxide, Blood (ICRP), Blood, Whole (ICRU), Bone Substitute (SB3), Bone Substitute (SB5, Epoxy-based), Bone, Compact (ICRU), Bone, Cortical (ICRP), Bone, Cortical (ICRU), Bone-Equivalent Plastic (B-100), Bone-Equivalent Plastic (B-110), Boron Carbide, Boron Oxide, Brain (ICRP), Brain, Grey and White Matter (ICRU), Breast Tissue (ICRU), Breast Tissue Substitute (BR12, Epoxy-based), Breast Tissue Substitute (Griffith), Butane, Cadmium Sulfide, Cadmium Telluride, Cadmium Tungstate, Calcium Carbonate, Calcium Fluoride, Calcium Oxide, Calcium Sulfate, Calcium Tungstate, Cameron Wax, Carbon Dioxide, Carbon Disulfide, Carbon Monoxide, Carbon Tetrachloride, Cell Nucleus (ICRU), Cell Nucleus (Typical), Cellophane, Cellulose Acetate (Cellophane), Cellulose Acetate Butyrate, Cellulose Nitrate, Cesium Chloride, Cesium Fluoride, Cesium Iodide, Chlorobenzene, Concrete (Ordinary), Concrete (Ordinary, Type 03), Concrete (Ordinary, Type 04), Concrete Barite (Type BA), Concrete Limonite and Steel (Type LS), Concrete Magnetite (Type M), Concrete Magnetite and Steel (Type MS2), Concrete Serpentine (Type S), Concrete, Copper Alloy (Admiralty Metal), Copper Alloy (Bell Metal), Copper Alloy (Cartridge Brass), Copper Alloy (Commercial Bronze), Copper Alloy (Commercial Leaded Bronze), Copper Alloy (Free Cutting Brass), Copper Alloy (Gunmetal), Copper Alloy (Low Brass), Copper Alloy (Manganese bronze), Copper Alloy (Muntzmetal), Copper Alloy (Naval Brass), Copper Alloy (Red Brass), Copper Alloy (Yellow Brass), Cyclohexane, Delrin, Dichlorodiethyl Ether, Diethyl Ether, Dimethylsulf Oxide, Dosimeter Solutiom, 0.015 M Ceric Ammonium Sulfate, Dosimeter Solution, 0.0015 M Ceric+0.0030 M Cerous Sulfate, Dosimeter Solution, 0.010 M Ceric+0.010 M Ceroussulfate, Dosimeter Solution, 0.015 M Ceric+0.015 M Cerous Sulfate, Dosimeter Solution, 0.020 M Cric Ammonium Sulfate, Dosimeter Solution, Ethanol-Monochlorobenzene, Dosimeter Solution, Ferrous Ammonium Sulfate (Standard Fricke), Dosimeter Solution, Ferrous Ammonium Sulfate (Super Fricke), Dosimeter Solution, Ferrous Sulfate (Standard Fricke), Dosimeter Solution, Ferrous Sulfate (Super Ficke), Dosimeter Solution, Potassium Dichromate (Standard), Dosimter Solution, Potassium Dichromate (Hi-Dose), Ethane, Ethoxyethanol, Ethyl Acetate, Ethyl Alcohol, Ethyl Cellulose, Ethyl Ether, Ethylene Ethene, Ethylene Glycol, Eye Lens (ICRP), Eye Lens (ICRU), Ferric Oxide, Ferroboride, Ferrous Oxide, Freon (12), Freon (12b2), Freon (13), Freon (13b1), Freon (13i1), GI-tract Intestine (ICRU), Gadolinium Oxysulfide, Gallium Arsenide, Gel in Photographic Emulsion (Standard Nuclear), Glass (Lead), Glass (Plate), Glass Borosilicate (Corning Pyrex 7740), Glucose (Dextrose), Glutamine, Glycerol].
```

--------------------------------

### POST /api/calculate-material-thickness-hvl/

Source: https://spekpy.smile.ki.se/api/docs

Calculates the Half-Value Layer (HVL) for a given material and spectrum. This is crucial for understanding radiation penetration and shielding effectiveness.

```APIDOC
## POST /api/calculate-material-thickness-hvl/

### Description
Calculates the Half-Value Layer (HVL) for a given material and spectrum. This is crucial for understanding radiation penetration and shielding effectiveness.

### Method
POST

### Endpoint
/api/calculate-material-thickness-hvl/

### Parameters
#### Request Body
- **spectrum** (SpwSpectrumRequest) - Required - The spectrum for which to calculate the HVL.
- **filtration_materials** (array of SpwFiltrationMaterialsResponse) - Required - A list of filtration materials to consider.
- **target_material** (SpwMaterialInfo) - Required - The target material for the calculation.
- **physics_model** (string) - Required - The physics model to use for the calculation.

### Request Example
{
  "spectrum": {
    "kvp": 100,
    "target_material": {
      "name": "Tungsten",
      "density": 19.3,
      "atomic_number": 74
    },
    "filtration_materials": [
      {
        "name": "Aluminum",
        "density": 2.7,
        "atomic_number": 13,
        "thickness_mm": 1.0
      }
    ],
    "physics_model": "SpekPy-basic"
  },
  "filtration_materials": [
    {
      "name": "Aluminum",
      "density": 2.7,
      "atomic_number": 13,
      "thickness_mm": 1.0
    }
  ],
  "target_material": {
    "name": "Tungsten",
    "density": 19.3,
    "atomic_number": 74
  },
  "physics_model": "SpekPy-basic"
}

### Response
#### Success Response (200)
- **hvl_response** (SpwMaterialThicknessHvlResponse) - The calculated Half-Value Layer information.

#### Response Example
{
  "hvl_response": {
    "hvl_mm": 2.5,
    "material": {
      "name": "Aluminum",
      "density": 2.7,
      "atomic_number": 13
    }
  }
}
```

--------------------------------

### POST /api/calculate-material-thickness-fraction/

Source: https://spekpy.smile.ki.se/api/docs

Calculates the thickness fraction of materials for a given spectrum. This endpoint is useful for understanding material composition in radiation shielding or filtering applications.

```APIDOC
## POST /api/calculate-material-thickness-fraction/

### Description
Calculates the thickness fraction of materials for a given spectrum. This endpoint is useful for understanding material composition in radiation shielding or filtering applications.

### Method
POST

### Endpoint
/api/calculate-material-thickness-fraction/

### Parameters
#### Request Body
- **spectrum** (SpwSpectrumRequest) - Required - The spectrum for which to calculate material thickness fractions.
- **filtration_materials** (array of SpwFiltrationMaterialsResponse) - Required - A list of filtration materials to consider.
- **target_material** (SpwMaterialInfo) - Required - The target material for the calculation.
- **physics_model** (string) - Required - The physics model to use for the calculation.

### Request Example
{
  "spectrum": {
    "kvp": 100,
    "target_material": {
      "name": "Tungsten",
      "density": 19.3,
      "atomic_number": 74
    },
    "filtration_materials": [
      {
        "name": "Aluminum",
        "density": 2.7,
        "atomic_number": 13,
        "thickness_mm": 1.0
      }
    ],
    "physics_model": "SpekPy-basic"
  },
  "filtration_materials": [
    {
      "name": "Aluminum",
      "density": 2.7,
      "atomic_number": 13,
      "thickness_mm": 1.0
    }
  ],
  "target_material": {
    "name": "Tungsten",
    "density": 19.3,
    "atomic_number": 74
  },
  "physics_model": "SpekPy-basic"
}

### Response
#### Success Response (200)
- **thickness_fraction** (SpwMaterialThicknessFractionResponse) - The calculated thickness fraction of materials.

#### Response Example
{
  "thickness_fraction": {
    "material_thicknesses": [
      {
        "material": {
          "name": "Aluminum",
          "density": 2.7,
          "atomic_number": 13
        },
        "thickness_mm": 0.5
      }
    ]
  }
}
```

--------------------------------

### SpwMaterialInfo

Source: https://spekpy.smile.ki.se/api/json

Schema for material information, including density, display name, and internal name.

```APIDOC
## SpwMaterialInfo

### Description
This schema provides detailed information about a specific material, including its physical properties and identifiers.

### Schema
```json
{
  "density_g_cm3": "number",
  "display_name": "string",
  "name": "string"
}
```

### Fields
- **density_g_cm3** (number) - Optional - Mass density in g/cm3.
- **display_name** (string) - Optional - Easy to read material name.
- **name** (string) - Optional - Material name. This material name shall be used in the API requests.
```

--------------------------------

### SpwFiltrationMaterialsResponse

Source: https://spekpy.smile.ki.se/api/json

Response schema for filtration materials, containing a list of SpwMaterialInfo objects.

```APIDOC
## SpwFiltrationMaterialsResponse

### Description
This schema defines the response structure for filtration materials, which includes a list of available materials.

### Schema
```json
{
  "materials": [
    {
      "density_g_cm3": "number",
      "display_name": "string",
      "name": "string"
    }
  ]
}
```

### Fields
- **materials** (array) - Required - List of materials.
```

--------------------------------

### Calculate Material Thickness Fraction

Source: https://spekpy.smile.ki.se/api/json

Calculates the material thickness required to reduce the air kerma to a specific fraction of its original value.

```APIDOC
## POST /api/calculate-material-thickness-fraction/

### Description
Calculate the material thickness needed to reduce the air kerma to a specific fraction.

### Method
POST

### Endpoint
/api/calculate-material-thickness-fraction/

### Request Body
- **fraction** (number) - Required - The desired fraction of the original air kerma.
- **material** (string) - Required - The material to use for filtration.
- **spectrum_request** (object) - Required - The spectrum request object, same as used in the calculate-spectrum endpoint.

### Response
#### Success Response (200)
- **thickness** (number) - The required thickness of the material in mm.
```

--------------------------------

### SpwKvrangeResponse

Source: https://spekpy.smile.ki.se/api/json

Response schema for key-value range, specifying minimum and maximum kV values.

```APIDOC
## SpwKvrangeResponse

### Description
This schema defines the response structure for key-value range queries, providing the minimum and maximum kV values.

### Schema
```json
{
  "kv_max": "number",
  "kv_min": "number"
}
```

### Fields
- **kv_max** (number) - Optional - Maximum kV.
- **kv_min** (number) - Optional - Minimum kV.
```

--------------------------------

### List Filtration Materials

Source: https://spekpy.smile.ki.se/api/json

Retrieves a list of available filtration materials that can be used in the API.

```APIDOC
## GET /api/filtration-materials/

### Description
List available filtration materials.

### Method
GET

### Endpoint
/api/filtration-materials/

### Response
#### Success Response (200)
- **filtration_materials** (array) - List of available filtration materials.
```

--------------------------------

### Calculate X-ray Spectrum

Source: https://spekpy.smile.ki.se/api/json

Calculates an x-ray spectrum based on the provided request parameters. This includes settings for the tube voltage, current, target material, filtration, and physics model.

```APIDOC
## POST /api/calculate-spectrum/

### Description
Calculate an x-ray spectrum.

### Method
POST

### Endpoint
/api/calculate-spectrum/

### Request Body
- **bremsstrahlung** (boolean) - Optional - Include bremsstrahlung in the spectrum.
- **char_xray** (boolean) - Optional - Include characteristic x-rays in the spectrum.
- **energy_bin** (number) - Optional - Width of the spectrum energy bins. Unit: keV.
- **filtration_table** (array) - Optional - Beam filtration. List of (material, thickness) pairs. Unit for thickness: mm.
- **kv** (number) - Optional - Tube voltage. Unit: kV
- **mas** (number) - Optional - Tube change. Unit: mAs.
- **physics** (string) - Optional - Physics model. Allowed values: ["casim", "kqp", "spekpy-v1", "spekcalc"].
- **target_material** (string) - Optional - Anode target material. Allowed values: ["W", "Rh", "Mo"].
- **x** (number) - Optional - Position in x direction. Unit: cm.
- **y** (number) - Optional - Position in y direction. Unit: cm.
- **z** (number) - Optional - Position in z direction. Unit: cm.

### Response
#### Success Response (200)
- **al_eeff** (number) - Effective energy in terms of Al. Unit: keV.
- **al_hc** (number) - Homogeneity coefficient of Al. Unit: no unit.
- **al_hvl1** (number) - First half value layer of Al. Unit: mm.
- **al_hvl2** (number) - Second half value layer of Al. Unit: mm.
- **cu_eeff** (number) - Effective energy in terms of Cu. Unit: keV.
- **cu_hc** (number) - Homogeneity coefficient of Cu. Unit: no unit.
- **cu_hvl1** (number) - First half value layer of Cu. Unit: mm.
- **cu_hvl2** (number) - Second half value layer of Cu. Unit: mm.
- **emean** (number) - Mean energy of spectrum. Unit: keV.
- **kerma** (number) - Air Kerma calculated from spectrum. Unit: µGy.
- **spekpy_version** (string) - Version of SpekPy used in the calculations.
- **table_data** (array) - The calculated spectrum. The spectrum is represented as an array where each item is a value pair (energy bin center, fluence). The energy bin centers are given in keV and the fluences are given in cm^-2 keV^-1.
- **table_labels** (array) - Labels for the columns in data_table.
```

--------------------------------

### Calculate Material Thickness HVL

Source: https://spekpy.smile.ki.se/api/json

Calculates the material thickness required to achieve a desired half value layer (HVL).

```APIDOC
## POST /api/calculate-material-thickness-hvl/

### Description
Calculate the material thickness needed to get a desired half value layer.

### Method
POST

### Endpoint
/api/calculate-material-thickness-hvl/

### Request Body
- **hvl** (number) - Required - The desired half value layer in mm.
- **material** (string) - Required - The material to use for filtration.
- **spectrum_request** (object) - Required - The spectrum request object, same as used in the calculate-spectrum endpoint.

### Response
#### Success Response (200)
- **thickness** (number) - The required thickness of the material in mm.
```
Tokens:
Raw