repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
unknown | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
NCATSTranslator/Knowledge_Graph_Exchange_Registry | 74769a3edc37e68b1bc4fef035f5f1f31685b37e | "2021-08-23T02:17:33" | kgea/server/web_services/catalog/content_metadata.schema.json | 5 | 2024-05-27T22:46:52.626016Z | {
"$defs": {
"BiolinkEntity": {
"description": "Compact URI (CURIE) for a Biolink class, biolink:NamedThing or a child thereof. The CURIE must use the prefix 'biolink:' followed by the PascalCase class name.",
"pattern": "^biolink:[A-Z][a-zA-Z]*$",
"type": "string"
},
"BiolinkPredicate": {
"description": "CURIE for a Biolink 'predicate' slot, taken from the Biolink slot ('is_a') hierarchy rooted in biolink:related_to (snake_case). This predicate defines the Biolink relationship between the subject and object nodes of a biolink:Association defining a knowledge graph edge.",
"pattern": "^biolink:[a-z][a-z_]*$",
"type": "string"
},
"MetaEdge": {
"additionalProperties": false,
"description": "Edge in a meta knowledge map describing relationship between a subject Biolink class and an object Biolink class.",
"properties": {
"count": {
"description": "Total number of edge instances of this (subject, predicate, object) triple known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Counts of node instances, binned by knowledge source provenance categories",
"patternProperties": {
"^(provided_by|knowledge_source|aggregating_knowledge_source|original_knowledge_source)$": {
"additionalProperties": false,
"description": "Count of node instances by source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|((\\w|\\.)+:)?(\\w|\\.|-)+)$": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"object": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Object node category of this relationship edge."
},
"predicate": {
"$ref": "#/$defs/BiolinkPredicate",
"description": "Biolink relationship between the subject and object categories."
},
"relations": {
"description": "Low-level relations from the underlying source.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Subject node category of this relationship edge."
}
},
"required": [
"subject",
"predicate",
"object"
],
"type": "object"
},
"MetaNode": {
"additionalProperties": false,
"properties": {
"count": {
"description": "Total number of node instances of this node category known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Counts of node instances, binned by knowledge source provenance categories",
"patternProperties": {
"^provided_by$": {
"additionalProperties": false,
"description": "Count of node instances by source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|((\\w|\\.)+:)?(\\w|\\.|-)+)$": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"id_prefixes": {
"description": "List of CURIE prefixes for the node category that this Knowledge Graph contains.",
"items": {
"pattern": "^[a-zA-Z_.]+$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id_prefixes"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/master/kgea/api/content_metadata.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Description of a node category for Knowledge Graph eXchange (KGX) knowledge graph content metadata",
"properties": {
"edges": {
"description": "List of edges/predicates provided by this knowledge graph.",
"items": {
"$ref": "#/$defs/MetaEdge"
},
"type": "array"
},
"nodes": {
"additionalProperties": false,
"description": "Collection of node categories provided by this TRAPI web service, indexed by Biolink class CURIEs.",
"patternProperties": {
"^biolink:[A-Z][a-zA-Z]*$": {
"$ref": "#/$defs/MetaNode"
}
},
"type": "object"
}
},
"required": [
"nodes",
"edges"
],
"title": "KGX Content Metadata",
"type": "object"
} | MIT | en |
NCATSTranslator/Knowledge_Graph_Exchange_Registry | 5d781ae79942c05b45f5728294a409cc803423dd | "2021-04-22T17:01:53" | kgea/server/web_services/catalog/content_metadata.schema.json | 5 | 2024-05-27T22:46:52.626016Z | {
"$id": "https://raw.githubusercontent.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/master/kgea/api/content_metadata.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Knowledge Graph eXchange (KGX) knowledge graph content metadata JSON schema; See https://github.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/blob/master/KGE_METADATA.md",
"title": "KGX Content Metadata",
"type": "object"
} | MIT | en |
NCATSTranslator/Knowledge_Graph_Exchange_Registry | 7374c2187b4d30d0dd6656c52af6e94029773ab3 | "2021-07-29T23:56:01" | kgea/server/web_services/catalog/content_metadata.schema.json | 5 | 2024-05-27T22:46:52.626016Z | {
"$defs": {
"BiolinkEntity": {
"description": "Compact URI (CURIE) for a Biolink class, biolink:NamedThing or a child thereof. The CURIE must use the prefix 'biolink:' followed by the PascalCase class name.",
"pattern": "^biolink:[A-Z][a-zA-Z]*$",
"type": "string"
},
"BiolinkPredicate": {
"description": "CURIE for a Biolink 'predicate' slot, taken from the Biolink slot ('is_a') hierarchy rooted in biolink:related_to (snake_case). This predicate defines the Biolink relationship between the subject and object nodes of a biolink:Association defining a knowledge graph edge.",
"pattern": "^biolink:[a-z][a-z_]*$",
"type": "string"
},
"MetaEdge": {
"additionalProperties": false,
"description": "Edge in a meta knowledge map describing relationship between a subject Biolink class and an object Biolink class.",
"properties": {
"count": {
"description": "Total number of edge instances of this (subject, predicate, object) triple known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of edge instances by knowledge source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|((\\w|\\.)+:)?(\\w|\\.|-)+)$": {
"type": "integer"
}
},
"type": "object"
},
"object": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Object node category of this relationship edge."
},
"predicate": {
"$ref": "#/$defs/BiolinkPredicate",
"description": "Biolink relationship between the subject and object categories."
},
"relations": {
"description": "Low-level relations from the underlying source.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Subject node category of this relationship edge."
}
},
"required": [
"subject",
"predicate",
"object"
],
"type": "object"
},
"MetaNode": {
"additionalProperties": false,
"properties": {
"count": {
"description": "Total number of node instances of this node category known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of node instances by knowledge source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|((\\w|\\.)+:)?(\\w|\\.|-)+)$": {
"type": "integer"
}
},
"type": "object"
},
"id_prefixes": {
"description": "List of CURIE prefixes for the node category that this Knowledge Graph contains.",
"items": {
"pattern": "^[a-zA-Z_.]+$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id_prefixes"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/master/kgea/api/content_metadata.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Description of a node category for Knowledge Graph eXchange (KGX) knowledge graph content metadata",
"properties": {
"edges": {
"description": "List of edges/predicates provided by this knowledge graph.",
"items": {
"$ref": "#/$defs/MetaEdge"
},
"type": "array"
},
"nodes": {
"additionalProperties": false,
"description": "Collection of node categories provided by this TRAPI web service, indexed by Biolink class CURIEs.",
"patternProperties": {
"^biolink:[A-Z][a-zA-Z]*$": {
"$ref": "#/$defs/MetaNode"
}
},
"type": "object"
}
},
"required": [
"nodes",
"edges"
],
"title": "KGX Content Metadata",
"type": "object"
} | MIT | en |
NCATSTranslator/Knowledge_Graph_Exchange_Registry | 70b22a6d939b202bb50c9a08565b0f88b799a457 | "2021-05-29T00:07:32" | kgea/server/web_services/catalog/content_metadata.schema.json | 5 | 2024-05-27T22:46:52.626016Z | {
"$defs": {
"BiolinkEntity": {
"description": "Compact URI (CURIE) for a Biolink class, biolink:NamedThing or a child thereof. The CURIE must use the prefix 'biolink:' followed by the PascalCase class name.",
"pattern": "^biolink:[A-Z][a-zA-Z]*$",
"type": "string"
},
"BiolinkPredicate": {
"description": "CURIE for a Biolink 'predicate' slot, taken from the Biolink slot ('is_a') hierarchy rooted in biolink:related_to (snake_case). This predicate defines the Biolink relationship between the subject and object nodes of a biolink:Association defining a knowledge graph edge.",
"pattern": "^biolink:[a-z][a-z_]*$",
"type": "string"
},
"MetaEdge": {
"additionalProperties": false,
"description": "Edge in a meta knowledge map describing relationship between a subject Biolink class and an object Biolink class.",
"properties": {
"count": {
"description": "Total number of edge instances of this (subject, predicate, object) triple known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of edge instances by knowledge source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|([A-Z]+:)?[a-zA-Z_.]+)$": {
"type": "integer"
}
},
"type": "object"
},
"object": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Object node category of this relationship edge."
},
"predicate": {
"$ref": "#/$defs/BiolinkPredicate",
"description": "Biolink relationship between the subject and object categories."
},
"relations": {
"description": "Low-level relations from the underlying source.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"$ref": "#/$defs/BiolinkEntity",
"description": "Subject node category of this relationship edge."
}
},
"required": [
"subject",
"predicate",
"object"
],
"type": "object"
},
"MetaNode": {
"additionalProperties": false,
"properties": {
"count": {
"description": "Total number of node instances of this node category known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of node instances by knowledge source URI or CURIE or plain namespace identifier",
"patternProperties": {
"^(https?://[a-z.]+(/[a-zA-Z_.]+)*/?|([A-Z]+:)?[a-zA-Z_.]+)$": {
"type": "integer"
}
},
"type": "object"
},
"id_prefixes": {
"description": "List of CURIE prefixes for the node category that this Knowledge Graph contains.",
"items": {
"pattern": "^[a-zA-Z_.]+$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id_prefixes"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/master/kgea/api/content_metadata.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Description of a node category for Knowledge Graph eXchange (KGX) knowledge graph content metadata",
"properties": {
"edges": {
"description": "List of edges/predicates provided by this knowledge graph.",
"items": {
"$ref": "#/$defs/MetaEdge"
},
"type": "array"
},
"nodes": {
"additionalProperties": false,
"description": "Collection of node categories provided by this TRAPI web service, indexed by Biolink class CURIEs.",
"patternProperties": {
"^biolink:[A-Z][a-zA-Z]*$": {
"$ref": "#/$defs/MetaNode"
}
},
"type": "object"
}
},
"required": [
"nodes",
"edges"
],
"title": "KGX Content Metadata",
"type": "object"
} | MIT | en |
NCATSTranslator/Knowledge_Graph_Exchange_Registry | 881b6ba70364a505202c8884f5978afe9df69067 | "2021-04-23T00:20:09" | kgea/server/web_services/catalog/content_metadata.schema.json | 5 | 2024-05-27T22:46:52.626016Z | {
"$defs": {
"meta_edge": {
"additionalProperties": false,
"description": "Edge in a meta knowledge map describing relationship between a subject Biolink class and an object Biolink class.",
"properties": {
"count": {
"description": "Total number of edge instances of this (subject, predicate, object) triple known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of edge instances by their source.",
"patternProperties": {
"^[a-zA-Z_.]+$": {
"type": "integer"
}
},
"type": "object"
},
"object": {
"$ref": "#/components/schemas/BiolinkEntity",
"description": "Object node category of this relationship edge."
},
"predicate": {
"$ref": "#/components/schemas/BiolinkPredicate",
"description": "Biolink relationship between the subject and object categories."
},
"relations": {
"description": "Low-level relations from the underlying source.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"$ref": "#/components/schemas/BiolinkEntity",
"description": "Subject node category of this relationship edge."
}
},
"required": [
"subject",
"predicate",
"object"
],
"type": "object"
},
"meta_node": {
"additionalProperties": false,
"properties": {
"count": {
"description": "Total number of node instances of this node category known to this knowledge graph, or -1 if the number is not known.",
"type": "integer"
},
"count_by_source": {
"additionalProperties": false,
"description": "Number of node instances by their CURIE ID prefix source",
"patternProperties": {
"^[a-zA-Z_.]+$": {
"type": "integer"
}
},
"type": "object"
},
"id_prefixes": {
"description": "List of CURIE prefixes for the node category that this Knowledge Graph contains.",
"items": {
"pattern": "^[a-zA-Z_.]+$",
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"id_prefixes"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/NCATSTranslator/Knowledge_Graph_Exchange_Registry/master/kgea/api/content_metadata.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Description of a node category for Knowledge Graph eXchange (KGX) knowledge graph content metadata",
"properties": {
"edges": {
"description": "List of edges/predicates provided by this knowledge graph.",
"items": {
"$ref": "#/$defs/meta_edge"
},
"type": "array"
},
"nodes": {
"additionalProperties": false,
"description": "Collection of node categories provided by this TRAPI web service, indexed by Biolink class CURIEs.",
"patternProperties": {
"^biolink:[A-Z][a-zA-Z]*$": {
"$ref": "#/$defs/meta_node"
}
},
"type": "object"
}
},
"required": [
"nodes",
"edges"
],
"title": "KGX Content Metadata",
"type": "object"
} | MIT | en |
vertexproject/synapse | 0c6df238987e71e63671a5d7e1bb48eb110f40aa | "2023-10-06T17:36:31" | synapse/data/attack-flow/attack-flow-schema-2.0.0.json | 342 | 2024-05-28T03:18:36.825194Z | {
"$defs": {
"attack-action": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "An ``attack-action`` object represents the execution of a particular technique, i.e. a discrete unit of adverary behavior.",
"properties": {
"asset_refs": {
"description": "The assets involved in this action, i.e. where this action modifies or depends on the state of the asset.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-asset)--"
}
]
},
"minItems": 1,
"type": "array"
},
"command_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^process--"
}
],
"description": "Describe tools or commands executed by the attacker by referring to a STIX Process object, which can represent commands, environment variables, process image, etc."
},
"description": {
"description": "A description of the adversary behavior, e.g. what they did, how they did it, and why. This field may contain prose as well as technical information, but consider using ``command_ref`` for providing technical details about technique execution.",
"type": "string"
},
"effect_refs": {
"description": "The potential effects that result from executing this action. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"execution_end": {
"$ref": "https://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/timestamp.json",
"description": "Timestamp indicating when the execution of this action ended."
},
"execution_start": {
"$ref": "https://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/timestamp.json",
"description": "Timestamp indicating when the execution of this action began."
},
"extensions": {
"$ref": "#/$defs/extensions"
},
"name": {
"description": "The name of the technique, or if a specific technique is not known, then the name of the tactic.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"tactic_id": {
"description": "A tactic identifier or shortname that may reference an authoritative collection of tactics, e.g. ATT&CK.",
"type": "string"
},
"tactic_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
}
],
"description": "A reference to the tactic's STIX representation. For ATT&CK, this should be an ``x-mitre-tactic`` object."
},
"technique_id": {
"description": "A technique identifier or shortname that may reference an authoritative collection of techniques, e.g. ATT&CK.",
"type": "string"
},
"technique_ref": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^attack-pattern--"
}
],
"description": "A reference to the technique's STIX representation."
},
"type": {
"const": "attack-action",
"description": "The type **MUST** be ``attack-action``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"extensions"
],
"type": "object",
"x-exampleObject": "attack-action--37345417-3ee0-4e11-b421-1d4be68e6f15"
},
"attack-asset": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "An asset is any object that is the subject or target of an action. Assets can be technical assets (such as machines and data) or non-technical assets such as people and physical systems. Actions typically either modify or depend upon the *state* of an asset in some way.\n\nNote that assets are not applicable in all contexts. For example, public threat reports may not include enough detail to represent the assets in a flow, or the flow might represent aggregate behavior (at the campaign or actor level) for which it does not make sense to specify an asset. Assets should be used to add context to a flow when the underlying intelligence contains sufficient detail to do so.",
"properties": {
"description": {
"description": "A description of the asset.",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/extensions"
},
"name": {
"description": "An name for the asset.",
"type": "string"
},
"object_ref": {
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json",
"description": "A reference to any STIX data object (i.e. SDO) or observable (i.e. SCO) that contains structured data about this asset."
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-asset",
"description": "The type **MUST** be ``attack-asset``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"extensions"
],
"type": "object",
"x-exampleObject": "attack-asset--f7edf4aa-29ec-47aa-b4f6-c42dfbe2ac20"
},
"attack-condition": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "An ``attack-condition`` object represents some possible condition, outcome, or state that could occur. Conditions can be used to split flows based on the success or failure of an action, or to provide further description of an action's results.",
"properties": {
"description": {
"description": "The condition that is evaluated, usually based on the success or failure of the preceding action.",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/extensions"
},
"on_false_refs": {
"description": "When the condition is ``false``, the flow continues to these objects. (If there are no objects, then the flow halts at this node.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"on_true_refs": {
"description": "When the condition is ``true``, the flow continues to these objects.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"pattern": {
"description": "*(This is an experimental feature.)* The detection pattern for this condition may be expressed as a STIX Pattern or another appropriate language such as SNORT, YARA, etc.",
"type": "string"
},
"pattern_type": {
"description": "*(This is an experimental feature.)* The pattern langauge used in this condition. The value for this property should come from the STIX ``pattern-type-ov`` open vocabulary.",
"type": "string"
},
"pattern_version": {
"description": "*(This is an experimental feature.)* The version of the pattern language used for the data in the ``pattern`` property. For the STIX Pattern language, the default value is determined by the ``spec_version`` of the condition object.",
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-condition",
"description": "The type **MUST** be ``attack-condition``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"description",
"extensions"
],
"type": "object",
"x-exampleObject": "attack-condition--7e809f5b-319a-4b3f-82fe-e4dc09af5088"
},
"attack-flow": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "Every Attack Flow document **MUST** contain exactly one ``attack-flow`` object. It provides metadata for name and description, starting points for the flow of actions, and can be referenced from other STIX objects.",
"properties": {
"description": {
"description": "A description of the overall Attack Flow.",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/extensions"
},
"name": {
"description": "The name of the Attack Flow.",
"type": "string"
},
"scope": {
"description": "Indicates what type of behavior the Attack Flow describes: a specific incident, a campaign, etc.",
"enum": [
"incident",
"campaign",
"threat-actor",
"malware",
"other"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"start_refs": {
"description": "A list of objects that start the flow.",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"type": {
"const": "attack-flow",
"description": "The type **MUST** be ``attack-flow``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"name",
"start_refs",
"scope",
"extensions"
],
"type": "object",
"x-exampleObject": "attack-flow--e9ec3a4b-f787-4e81-a3d9-4cfe017ebc2f"
},
"attack-operator": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "An ``attack-operator`` object joins multiple attack paths together using boolean logic.",
"properties": {
"effect_refs": {
"description": "The effects, outcomes, or states that result when this operator evaluates to ``true``. If the operator evaluates to ``false``, then the flow halts. (See: :ref:`effects`.)",
"items": {
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/identifier.json"
},
{
"pattern": "^(attack-action|attack-operator|attack-condition)--"
}
]
},
"minItems": 1,
"type": "array"
},
"extensions": {
"$ref": "#/$defs/extensions"
},
"operator": {
"description": "The logical operator to apply to the input effects.",
"enum": [
"AND",
"OR"
],
"type": "string"
},
"spec_version": {
"const": "2.1",
"description": "The version **MUST** be ``2.1``.",
"type": "string"
},
"type": {
"const": "attack-operator",
"description": "The type **MUST** be ``attack-operator``.",
"type": "string"
}
},
"required": [
"type",
"spec_version",
"operator",
"extensions"
],
"type": "object",
"x-exampleObject": "attack-operator--609d7adf-a3d2-44e8-82de-4b30e3fb97be"
},
"extensions": {
"properties": {
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4": {
"properties": {
"extension_type": {
"const": "new-sdo",
"type": "string"
}
},
"required": [
"extension_type"
],
"type": "object"
}
},
"required": [
"extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4"
],
"type": "object"
}
},
"$id": "https://center-for-threat-informed-defense.github.io/attack-flow/schema/attack-flow-schema-2.0.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"allOf": [
{
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
}
],
"description": "This schema is the normative definition of the STIX 2.1 extension `extension-definition--fb9c968a-745b-4ade-9b25-c324172197f4`. It extends STIX with additional STIX Data Objects (SDOs) that model Attack Flow concepts.",
"properties": {
"objects": {
"$comment": "Attack Flow documents MUST have ONLY ONE 'attack-flow' type. That is enforced here with the 'contains', 'minContains', and 'maxContains'",
"contains": {
"$ref": "#/$defs/attack-flow"
},
"items": {
"$comment": "Try each of the Attack Flow types in order, eventually falling through to the STIX common object definition.",
"else": {
"else": {
"else": {
"else": {
"else": {
"$comment": "All Attack Flow SDOs implement the required common properties.",
"$ref": "http://raw.githubusercontent.com/oasis-open/cti-stix2-json-schemas/stix2.1/schemas/common/core.json"
},
"if": {
"properties": {
"type": {
"const": "attack-operator",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-operator"
}
},
"if": {
"properties": {
"type": {
"const": "attack-condition",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-condition"
}
},
"if": {
"properties": {
"type": {
"const": "attack-asset",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-asset"
}
},
"if": {
"properties": {
"type": {
"const": "attack-action",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-action"
}
},
"if": {
"properties": {
"type": {
"const": "attack-flow",
"type": "string"
}
},
"type": "object"
},
"then": {
"$ref": "#/$defs/attack-flow"
}
},
"maxContains": 1,
"minContains": 1,
"type": "array"
},
"type": {
"const": "bundle"
}
},
"title": "Attack Flow STIX 2.1 Extension",
"type": "object",
"unevaluatedProperties": false
} | Apache-2.0 | en |
quanxiang-cloud/quanxiang | 945fc83dd71eb5917ab5ce0b7d70e58061000abd | "2023-03-27T11:03:08" | deployment/charts/nginx-ingress/values.schema.json | 132 | 2024-05-27T04:58:59.167515Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"default": {},
"examples": [
{
"controller": {
"affinity": {},
"appprotect": {
"enable": false,
"logLevel": "fatal"
},
"appprotectdos": {
"debug": false,
"enable": false,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
},
"config": {
"annotations": {},
"entries": {},
"name": ""
},
"customConfigMap": "",
"customPorts": [],
"defaultTLS": {
"cert": "",
"key": "",
"secret": ""
},
"disableIPV6": false,
"enableCertManager": false,
"enableCustomResources": true,
"enableExternalDNS": false,
"enableLatencyMetrics": false,
"enableOIDC": false,
"enablePreviewPolicies": false,
"enableSnippets": false,
"enableTLSPassthrough": false,
"extraContainers": [],
"globalConfiguration": {
"create": false,
"spec": {}
},
"healthStatus": false,
"healthStatusURI": "/nginx-health",
"hostNetwork": false,
"image": {
"digest": "",
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
},
"includeYear": false,
"ingressClass": "nginx",
"initContainers": [],
"kind": "deployment",
"lifecycle": {},
"logLevel": 1,
"minReadySeconds": 0,
"name": "",
"nginxDebug": false,
"nginxReloadTimeout": 60000,
"nginxStatus": {
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
},
"nginxplus": false,
"nodeSelector": {},
"pod": {
"annotations": {},
"extraLabels": {}
},
"priorityClassName": "",
"readyStatus": {
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
},
"replicaCount": 1,
"reportIngressStatus": {
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
},
"resources": {
"requests": {
"cpu": "100m",
"memory": "128Mi"
}
},
"service": {
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"nodePort": "",
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"nodePort": "",
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"name": "",
"type": "LoadBalancer"
},
"serviceAccount": {
"imagePullSecretName": "",
"name": ""
},
"serviceMonitor": {
"create": false,
"endpoints": {},
"labels": {},
"name": "",
"selectorMatchLabels": {}
},
"setAsDefaultIngress": false,
"strategy": {},
"terminationGracePeriodSeconds": 30,
"tolerations": [],
"topologySpreadConstraints": {},
"volumeMounts": [],
"volumes": [],
"watchNamespace": "",
"wildcardTLS": {
"cert": "",
"key": "",
"secret": ""
}
},
"nginxServiceMesh": {
"enable": false,
"enableEgress": false
},
"prometheus": {
"create": true,
"port": 9113,
"scheme": "http",
"secret": ""
},
"rbac": {
"create": true
},
"serviceInsight": {
"create": true,
"port": 9114,
"scheme": "http",
"secret": ""
}
}
],
"properties": {
"controller": {
"default": {},
"examples": [
{
"affinity": {},
"appprotect": {
"enable": false,
"logLevel": "fatal"
},
"appprotectdos": {
"debug": false,
"enable": false,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
},
"config": {
"annotations": {},
"entries": {},
"name": ""
},
"customConfigMap": "",
"customPorts": [],
"defaultTLS": {
"cert": "",
"key": "",
"secret": ""
},
"disableIPV6": false,
"enableCertManager": false,
"enableCustomResources": true,
"enableExternalDNS": false,
"enableLatencyMetrics": false,
"enableOIDC": false,
"enablePreviewPolicies": false,
"enableSnippets": false,
"enableTLSPassthrough": false,
"extraContainers": [],
"globalConfiguration": {
"create": false,
"spec": {}
},
"healthStatus": false,
"healthStatusURI": "/nginx-health",
"hostNetwork": false,
"image": {
"digest": "",
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
},
"includeYear": false,
"ingressClass": "nginx",
"initContainers": [],
"kind": "deployment",
"lifecycle": {},
"logLevel": 1,
"minReadySeconds": 0,
"name": "",
"nginxDebug": false,
"nginxReloadTimeout": 60000,
"nginxStatus": {
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
},
"nginxplus": false,
"nodeSelector": {},
"pod": {
"annotations": {},
"extraLabels": {}
},
"priorityClassName": "",
"readyStatus": {
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
},
"replicaCount": 1,
"reportIngressStatus": {
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
},
"resources": {
"requests": {
"cpu": "100m",
"memory": "128Mi"
}
},
"service": {
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"name": "",
"type": "LoadBalancer"
},
"serviceAccount": {
"imagePullSecretName": "",
"name": ""
},
"serviceMonitor": {
"create": false,
"endpoints": {},
"labels": {},
"name": "",
"selectorMatchLabels": {}
},
"setAsDefaultIngress": false,
"strategy": {},
"terminationGracePeriodSeconds": 30,
"tolerations": [],
"topologySpreadConstraints": {},
"volumeMounts": [],
"volumes": [],
"watchNamespace": "",
"wildcardTLS": {
"cert": "",
"key": "",
"secret": ""
}
}
],
"properties": {
"affinity": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Affinity",
"default": {},
"title": "The affinity Schema",
"type": "object"
},
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"appprotect": {
"default": {},
"examples": [
{
"enable": true,
"logLevel": "fatal"
}
],
"properties": {
"enable": {
"default": false,
"examples": [
false,
true
],
"title": "Enable the App Protect WAF module in the Ingress Controller",
"type": "boolean"
},
"logLevel": {
"default": "",
"enum": [
"fatal",
"error",
"warn",
"info",
"debug",
"trace"
],
"examples": [
"fatal",
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "The logLevel for App Protect WAF",
"type": "string"
}
},
"required": [
"enable"
],
"title": "The App Protect WAF Schema",
"type": "object"
},
"appprotectdos": {
"default": {},
"examples": [
{
"debug": false,
"enable": true,
"maxDaemons": 0,
"maxWorkers": 0,
"memory": 0
}
],
"properties": {
"debug": {
"default": false,
"examples": [
false,
true
],
"title": "debugging for App Protect DoS",
"type": "boolean"
},
"enable": {
"default": false,
"examples": [
false,
true
],
"title": "Enable the App Protect DoS module in the Ingress Controller",
"type": "boolean"
},
"maxDaemons": {
"default": 0,
"examples": [
0
],
"title": "Max number of ADMD instances",
"type": "integer"
},
"maxWorkers": {
"default": 0,
"examples": [
0
],
"title": "Max number of nginx processes to support",
"type": "integer"
},
"memory": {
"default": 0,
"examples": [
0
],
"title": "RAM memory size to consume in MB",
"type": "integer"
}
},
"required": [
"enable"
],
"title": "The App Protect DoS Schema",
"type": "object"
},
"config": {
"default": {},
"examples": [
{
"annotations": {},
"entries": {},
"name": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"entries": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The entries Schema",
"type": "object"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The config Schema",
"type": "object"
},
"customConfigMap": {
"default": "",
"examples": [
""
],
"title": "The customConfigMap Schema",
"type": "string"
},
"customPorts": {
"default": [],
"examples": [
[
{
"containerPort": 80,
"name": "http",
"protocol": "TCP"
},
{
"containerPort": 443,
"name": "https",
"protocol": "TCP"
}
]
],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ContainerPort",
"type": "object"
},
"title": "The customPorts to expose on the NGINX Ingress Controller pod",
"type": "array"
},
"defaultTLS": {
"default": {},
"examples": [],
"properties": {
"cert": {
"default": "",
"examples": [],
"title": "The cert Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [],
"title": "The key Schema",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
}
},
"required": [],
"title": "The defaultTLS Schema",
"type": "object"
},
"disableIPV6": {
"default": false,
"examples": [
false
],
"title": "The disableIPV6",
"type": "boolean"
},
"dnsPolicy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/dnsPolicy"
},
{
"enum": [
"ClusterFirstWithHostNet",
"ClusterFirst",
"Default",
"None"
]
}
],
"type": "string"
},
"enableCertManager": {
"default": false,
"examples": [
false
],
"title": "The enableCertManager",
"type": "boolean"
},
"enableCustomResources": {
"default": false,
"examples": [
true
],
"title": "The enableCustomResources",
"type": "boolean"
},
"enableExternalDNS": {
"default": false,
"examples": [
false
],
"title": "The enableExternalDNS",
"type": "boolean"
},
"enableLatencyMetrics": {
"default": false,
"examples": [
false
],
"title": "The enableLatencyMetrics",
"type": "boolean"
},
"enableOIDC": {
"default": false,
"examples": [
false
],
"title": "The enableOIDC",
"type": "boolean"
},
"enablePreviewPolicies": {
"default": false,
"examples": [
false
],
"title": "The enablePreviewPolicies",
"type": "boolean"
},
"enableSnippets": {
"default": false,
"examples": [
false
],
"title": "The enableSnippets",
"type": "boolean"
},
"enableTLSPassthrough": {
"default": false,
"examples": [
false
],
"title": "The enableTLSPassthrough",
"type": "boolean"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container",
"type": "object"
},
"title": "The extraContainers Schema",
"type": "array"
},
"globalConfiguration": {
"default": {},
"examples": [
{
"create": false,
"spec": {}
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create Schema",
"type": "boolean"
},
"spec": {
"default": {},
"examples": [
{}
],
"properties": {
"listeners": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"examples": [
"dns-tcp"
],
"title": "The name",
"type": "string"
},
"port": {
"default": 0,
"examples": [
5353
],
"title": "The port",
"type": "integer"
},
"protocol": {
"default": "",
"examples": [
"TCP"
],
"title": "The protocol",
"type": "string"
}
},
"type": "object"
},
"title": "The listeners Schema",
"type": "array"
}
},
"required": [],
"title": "The spec Schema",
"type": "object"
}
},
"required": [
"create",
"spec"
],
"title": "The globalConfiguration Schema",
"type": "object"
},
"healthStatus": {
"default": false,
"examples": [
false
],
"title": "The healthStatus",
"type": "boolean"
},
"healthStatusURI": {
"default": "/nginx-health",
"examples": [
"/nginx-health"
],
"format": "uri-reference",
"title": "The healthStatusURI Schema",
"type": "string"
},
"hostNetwork": {
"default": false,
"examples": [
false,
true
],
"title": "The hostNetwork Schema",
"type": "boolean"
},
"image": {
"default": {},
"examples": [
{
"pullPolicy": "IfNotPresent",
"repository": "nginx/nginx-ingress",
"tag": "2.3.1"
}
],
"properties": {
"digest": {
"default": "",
"examples": [
"sha256:2710c264e8eaeb663cee63db37b75a1ac1709f63a130fb091c843a6c3a4dc572"
],
"title": "The digest of the Ingress Controller image",
"type": "string"
},
"pullPolicy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container/properties/imagePullPolicy"
},
{
"enum": [
"Always",
"IfNotPresent",
"Never"
]
}
],
"default": "IfNotPresent",
"examples": [
"Always",
"IfNotPresent",
"Never"
],
"title": "The pullPolicy for the Ingress Controller image",
"type": "string"
},
"repository": {
"default": "nginx/nginx-ingress",
"examples": [
"nginx/nginx-ingress"
],
"title": "The repository of the Ingress Controller",
"type": "string"
},
"tag": {
"default": "2.3.1",
"examples": [
"2.3.1"
],
"title": "The tag of the Ingress Controller image",
"type": "string"
}
},
"required": [
"repository",
"tag"
],
"title": "The image Schema",
"type": "object"
},
"includeYear": {
"default": false,
"examples": [
false
],
"title": "The includeYear",
"type": "boolean"
},
"ingressClass": {
"default": "",
"examples": [
"nginx"
],
"title": "The ingressClass",
"type": "string"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Container",
"type": "object"
},
"title": "The initContainers Schema",
"type": "array"
},
"kind": {
"default": "",
"enum": [
"deployment",
"daemonset"
],
"examples": [
"deployment",
"daemonset"
],
"title": "The kind of the Ingress Controller",
"type": "string"
},
"lifecycle": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Lifecycle",
"default": {},
"title": "The lifecycle Schema",
"type": "object"
},
"logLevel": {
"default": 1,
"enum": [
0,
1,
2,
3
],
"examples": [
1
],
"title": "The logLevel of the Ingress Controller",
"type": "integer"
},
"minReadySeconds": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentSpec/properties/minReadySeconds",
"default": 0,
"title": "The minReadySeconds Schema",
"type": "integer"
},
"name": {
"default": "",
"examples": [
"nginx-ingress"
],
"title": "The name of the Ingress Controller",
"type": "string"
},
"nginxDebug": {
"default": false,
"examples": [
false,
true
],
"title": "Enables debugging for NGINX",
"type": "boolean"
},
"nginxReloadTimeout": {
"default": 0,
"examples": [
60000
],
"title": "Timeout in milliseconds which the Ingress Controller will wait for a successful NGINX reload after a change or at the initial start",
"type": "integer"
},
"nginxStatus": {
"default": {},
"examples": [
{
"allowCidrs": "127.0.0.1",
"enable": true,
"port": 8080
}
],
"properties": {
"allowCidrs": {
"default": "127.0.0.1",
"examples": [
"127.0.0.1"
],
"title": "The allowCidrs",
"type": "string"
},
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"port": {
"default": 8080,
"examples": [
8080
],
"title": "The port",
"type": "integer"
}
},
"required": [],
"title": "The nginxStatus Schema",
"type": "object"
},
"nginxplus": {
"default": false,
"examples": [
false,
true
],
"title": "Deploys the Ingress Controller for NGINX Plus",
"type": "boolean"
},
"nodeSelector": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/nodeSelector",
"default": {},
"title": "The nodeSelector Schema",
"type": "object"
},
"pod": {
"default": {},
"examples": [
{
"annotations": {},
"extraLabels": {}
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"extraLabels": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels",
"default": {},
"title": "The extraLabels Schema",
"type": "object"
}
},
"required": [],
"title": "The pod Schema",
"type": "object"
},
"priorityClassName": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/priorityClassName",
"default": "",
"title": "The priorityClassName",
"type": "string"
},
"readyStatus": {
"default": {},
"examples": [
{
"enable": true,
"initialDelaySeconds": 0,
"port": 8081
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"initialDelaySeconds": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Probe/properties/initialDelaySeconds",
"default": 0,
"type": "integer"
},
"port": {
"default": 0,
"examples": [
8081
],
"title": "The port",
"type": "integer"
}
},
"required": [],
"title": "The readyStatus",
"type": "object"
},
"replicaCount": {
"default": 1,
"examples": [
1
],
"title": "The replicaCount",
"type": "integer"
},
"reportIngressStatus": {
"default": {},
"examples": [
{
"annotations": {},
"enable": true,
"enableLeaderElection": true,
"externalService": "",
"ingressLink": "",
"leaderElectionLockName": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"enableLeaderElection": {
"default": false,
"examples": [
true
],
"title": "The enableLeaderElection",
"type": "boolean"
},
"externalService": {
"default": "",
"examples": [
""
],
"title": "The externalService",
"type": "string"
},
"ingressLink": {
"default": "",
"examples": [
""
],
"title": "The ingressLink",
"type": "string"
},
"leaderElectionLockName": {
"default": "",
"examples": [
""
],
"title": "The leaderElectionLockName",
"type": "string"
}
},
"required": [
"enable"
],
"title": "The reportIngressStatus Schema",
"type": "object"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"title": "The resources Schema",
"type": "object"
},
"service": {
"default": {},
"examples": [
{
"allocateLoadBalancerNodePorts": false,
"annotations": {},
"create": true,
"customPorts": [],
"externalIPs": [],
"externalTrafficPolicy": "Local",
"extraLabels": {},
"httpPort": {
"enable": true,
"port": 80,
"targetPort": 80
},
"httpsPort": {
"enable": true,
"port": 443,
"targetPort": 443
},
"ipFamilies": [],
"ipFamilyPolicy": "",
"loadBalancerIP": "",
"loadBalancerSourceRanges": [],
"name": "",
"type": "LoadBalancer"
}
],
"properties": {
"allocateLoadBalancerNodePorts": {
"default": false,
"ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/allocateLoadBalancerNodePorts",
"title": "The allocateLoadBalancerNodePorts Schema",
"type": "boolean"
},
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations",
"type": "object"
},
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"customPorts": {
"default": [],
"items": {
"ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServicePort",
"type": "object"
},
"title": "The customPorts",
"type": "array"
},
"externalIPs": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalIPs",
"default": [],
"title": "The externalIPs",
"type": "array"
},
"externalTrafficPolicy": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/externalTrafficPolicy",
"default": "",
"title": "The externalTrafficPolicy",
"type": "string"
},
"extraLabels": {
"default": {},
"examples": [
{}
],
"properties": {},
"required": [],
"title": "The extraLabels",
"type": "object"
},
"httpPort": {
"default": {},
"examples": [
{
"enable": true,
"nodePort": "",
"port": 80,
"targetPort": 80
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"nodePort": {
"default": 0,
"examples": [
443
],
"title": "The nodePort",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
80
],
"title": "The port",
"type": "integer"
},
"targetPort": {
"default": 0,
"examples": [
80
],
"title": "The targetPort",
"type": "integer"
}
},
"required": [],
"title": "The httpPort",
"type": "object"
},
"httpsPort": {
"default": {},
"examples": [
{
"enable": true,
"nodePort": "",
"port": 443,
"targetPort": 443
}
],
"properties": {
"enable": {
"default": false,
"examples": [
true
],
"title": "The enable",
"type": "boolean"
},
"nodePort": {
"default": 0,
"examples": [
443
],
"title": "The nodePort",
"type": "integer"
},
"port": {
"default": 0,
"examples": [
443
],
"title": "The port",
"type": "integer"
},
"targetPort": {
"default": 0,
"examples": [
443
],
"title": "The targetPort",
"type": "integer"
}
},
"required": [],
"title": "The httpsPort",
"type": "object"
},
"ipFamilies": {
"default": [],
"ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilies",
"title": "The ipFamilies Schema",
"type": "array"
},
"ipFamilyPolicy": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/ipFamilyPolicy",
"default": "",
"examples": [
""
],
"title": "The ipFamilyPolicy Schema",
"type": "string"
},
"loadBalancerIP": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/loadBalancerIP",
"default": "",
"title": "The loadBalancerIP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"examples": [
[]
],
"items": {},
"title": "The loadBalancerSourceRanges",
"type": "array"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name",
"type": "string"
},
"type": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.ServiceSpec/properties/type",
"default": "",
"title": "The type",
"type": "string"
}
},
"required": [],
"title": "The service Schema",
"type": "object"
},
"serviceAccount": {
"default": {},
"examples": [
{
"imagePullSecretName": "",
"name": ""
}
],
"properties": {
"annotations": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/annotations",
"default": {},
"title": "The annotations Schema",
"type": "object"
},
"imagePullSecretName": {
"default": "",
"examples": [
""
],
"title": "The imagePullSecretName",
"type": "string"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name Schema",
"type": "string"
}
},
"required": [],
"title": "The serviceAccount Schema",
"type": "object"
},
"serviceMonitor": {
"default": {},
"examples": [
{
"create": false,
"endpoints": [],
"labels": {},
"name": "",
"selectorMatchLabels": {}
}
],
"properties": {
"create": {
"default": false,
"examples": [
false
],
"title": "The create",
"type": "boolean"
},
"endpoints": {
"default": [],
"items": {},
"required": [],
"title": "The endpoints",
"type": "array"
},
"labels": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta/properties/labels",
"default": {},
"title": "The labels Schema",
"type": "object"
},
"name": {
"default": "",
"examples": [
""
],
"title": "The name",
"type": "string"
},
"selectorMatchLabels": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector/properties/matchLabels",
"default": {},
"title": "The selectorMatchLabels Schema",
"type": "object"
}
},
"required": [],
"title": "The serviceMonitor Schema",
"type": "object"
},
"setAsDefaultIngress": {
"default": false,
"examples": [
false
],
"title": "The setAsDefaultIngress",
"type": "boolean"
},
"strategy": {
"allOf": [
{
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.apps.v1.DeploymentStrategy"
},
{
"properties": {
"type": {
"enum": [
"Recreate",
"RollingUpdate"
],
"type": "string"
}
}
}
],
"default": {},
"title": "The strategy Schema",
"type": "object"
},
"terminationGracePeriodSeconds": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.PodSpec/properties/terminationGracePeriodSeconds",
"default": 30,
"title": "The terminationGracePeriodSeconds Schema",
"type": "integer"
},
"tolerations": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"title": "The tolerations Schema",
"type": "array"
},
"topologySpreadConstraints": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"default": {},
"title": "The topologySpreadConstraints Schema",
"type": "object"
},
"volumeMounts": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount",
"type": "object"
},
"title": "The volumeMounts Schema",
"type": "array"
},
"volumes": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.25.4/_definitions.json#/definitions/io.k8s.api.core.v1.Volume",
"type": "object"
},
"title": "The volumes Schema",
"type": "array"
},
"watchNamespace": {
"default": "",
"examples": [
""
],
"title": "The watchNamespace",
"type": "string"
},
"watchSecretNamespace": {
"default": "",
"examples": [
""
],
"title": "The watchSecretNamespace",
"type": "string"
},
"wildcardTLS": {
"default": {},
"examples": [],
"properties": {
"cert": {
"default": "",
"examples": [
""
],
"title": "The cert Schema",
"type": "string"
},
"key": {
"default": "",
"examples": [
""
],
"title": "The key Schema",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret Schema",
"type": "string"
}
},
"required": [],
"title": "The wildcardTLS Schema",
"type": "object"
}
},
"required": [
"kind",
"image"
],
"title": "The Ingress Controller Helm Schema",
"type": "object"
},
"nginxServiceMesh": {
"default": {},
"examples": [
{
"enable": false,
"enableEgress": false
}
],
"properties": {
"enable": {
"default": false,
"examples": [
false
],
"title": "The enable",
"type": "boolean"
},
"enableEgress": {
"default": false,
"examples": [
false
],
"title": "The enableEgress",
"type": "boolean"
}
},
"required": [
"enable"
],
"title": "The nginxServiceMesh Schema",
"type": "object"
},
"prometheus": {
"default": {},
"examples": [
{
"create": true,
"port": 9113,
"scheme": "http",
"secret": ""
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"port": {
"default": 9113,
"examples": [
9113
],
"title": "The port",
"type": "integer"
},
"scheme": {
"default": "http",
"examples": [
"http"
],
"title": "The scheme",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret",
"type": "string"
}
},
"required": [
"create"
],
"title": "The prometheus Schema",
"type": "object"
},
"rbac": {
"default": {},
"examples": [
{
"create": true
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create Schema",
"type": "boolean"
}
},
"required": [
"create"
],
"title": "The rbac Schema",
"type": "object"
},
"serviceInsight": {
"default": {},
"examples": [
{
"create": true,
"port": 9114,
"scheme": "http",
"secret": ""
}
],
"properties": {
"create": {
"default": false,
"examples": [
true
],
"title": "The create",
"type": "boolean"
},
"port": {
"default": 9114,
"examples": [
9114
],
"title": "The port",
"type": "integer"
},
"scheme": {
"default": "http",
"examples": [
"http"
],
"title": "The scheme",
"type": "string"
},
"secret": {
"default": "",
"examples": [
""
],
"title": "The secret",
"type": "string"
}
},
"required": [
"create"
],
"title": "The Service Insight Schema",
"type": "object"
}
},
"required": [
"controller",
"rbac",
"prometheus",
"serviceInsight",
"nginxServiceMesh"
],
"title": "Root Schema",
"type": "object"
} | Apache-2.0 | en |
riehlegroup/msadoc | e871d5c0a7dc029f5fe3635d68470b6f83fe4183 | "2023-02-13T16:27:26" | schemas/service-doc.json | 8 | 2024-05-27T06:40:54.483567Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"apiDocumentation": {
"description": "The link to the API documentation.",
"markdownDescription": "The link to the API documentation.\n ### Best Practices\n - Maintain a markdown file in your microservice repository or you can link here.\n - Alternatively, use a documentation tool as [OpenAPI](https://support.smartbear.com/swaggerhub/docs/tutorials/openapi-3-tutorial.html) or [AsyncAPI](https://www.asyncapi.com/blog/understanding-asyncapis) to document your APIs and link to the running instance here.",
"type": "string"
},
"consumedAPIs": {
"description": "The APIs that the microservice consumes. The \"consumedAPI\" identifier has to match a \"providerAPI\" identifier in another microservice's msadoc.json in order to link them.",
"items": {
"type": "string"
},
"markdownDescription": "The APIs that the microservice consumes. The `consumedAPI` identifier has to match a `providerAPI` identifier in another microservice's `msadoc.json` in order to link them.\n ### Best Practices\n - Use this attribute to document synchronous API dependencies. For events use the attribute `subscribedEvents`.",
"type": "array"
},
"deploymentDocumentation": {
"description": "The link to the deployment documentation.",
"markdownDescription": "The link to the deployment documentation.\n ### Best Practices\n - Maintain a markdown file in your microservice repository or in the deployment repository that you can link here.",
"type": "string"
},
"developmentDocumentation": {
"description": "The link to the development documentation.",
"markdownDescription": "The link to the development documentation.\n ### Best Practices\n - Maintain a markdown file in your microservice repository that you can link here.",
"type": "string"
},
"extensions": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"type": "array"
}
]
},
"description": "You can easily add custom fields under the attribute \"extensions\".Extension field values can only be of type string, number, boolean, or array of these types. Extension fields are visualized in the UI in a very generic way.",
"markdownDescription": "You can easily add custom fields under the attribute `extensions`.\n Extension field values can only be of type `string`, `number`, `boolean`, or `array` of these types.\n Extension fields are visualized in the UI in a very generic way.\n ### Best Practices\n - Use extension fields to document things the base version does not support (as an alternative to tags).",
"type": "object"
},
"group": {
"description": "The group of the microservice. Supports multiple hierarchies separated by a dot, e.g. \"group.sub-group.sub-sub-group\". The group name will later be used as key to add more meta-data to the group.",
"markdownDescription": "The group of the microservice. Supports multiple hierarchies separated by a dot, e.g. `group.sub-group.sub-sub-group`. The `group` name will later be used as key to add more meta-data to the group.\n ### Best Practices\n - Use a consistent naming scheme across all groups.\n - Don't use spaces to avoid ambiguities.",
"type": "string"
},
"name": {
"description": "The name of the microservice. The name is used as key to identify and reference services.",
"markdownDescription": "The name of the microservice. The `name` is used as key to identify and reference services.\n ### Best Practices\n - Use a consistent naming scheme across all microservices.\n - Don't use spaces to avoid ambiguities.",
"type": "string"
},
"providedAPIs": {
"description": "The APIs that the microservice provides. The \"consumedAPI\" identifier of other microservices have to match with the here chosen \"providerAPI\" in order to link them. A microservice can provide multiple APIs allowing to document more fine-granularly. The chosen formatting as string is deliberatively chosen to allow documenting multiple communication protocols.",
"items": {
"type": "string"
},
"markdownDescription": "The APIs that the microservice provides. The `consumedAPI` identifier of other microservices have to match with the here chosen `providerAPI` in order to link them. A microservice can provide multiple APIs allowing to document more fine-granularly. The chosen formatting as string is deliberatively chosen to allow documenting multiple communication protocols.\n ### Best Practices\n - Use this attribute to document synchronous API dependencies. For events use the attribute `publishedEvents`.\n - Use a consistent naming scheme for APIs across all microservices.\n - Consider if you can uniquely identify an API via its route, e.g. `/pipelines` to add more expressiveness to the documentation. Otherwise you can use custom names as e.g. `PipelineApi`.\n - Don't use spaces to avoid ambiguities.",
"type": "array"
},
"publishedEvents": {
"description": "The events that the microservice publishes. The \"subscribedEvents\" identifier of other microservices have to match with the here chosen \"publishedEvents\" in order to link them. A microservice can provide multiple events allowing to document more fine-grained. The chosen formatting as string is deliberatively chosen to allow documenting multiple communication protocols.",
"items": {
"type": "string"
},
"markdownDescription": "The events that the microservice publishes. The `subscribedEvents` identifier of other microservices have to match with the here chosen `publishedEvents` in order to link them. A microservice can provide multiple events allowing to document more fine-grained. The chosen formatting as string is deliberatively chosen to allow documenting multiple communication protocols.\n ### Best Practices\n - Use this attribute to document asynchronous event dependencies. For synchronous APIs like HTTP or RPC use the attribute `providedAPIs`.\n - Use a consistent naming scheme for events across all microservices.\n - Consider if you can uniquely identify an event via its routing key, e.g. `datasources.config.created` to add more expressiveness to the documentation. Otherwise you can use custom names as e.g. `DatasourceConfigCreatedEvent`.\n - Don't use spaces to avoid ambiguities.",
"type": "array"
},
"repository": {
"description": "The link to the microservice's repository.",
"markdownDescription": "The link to the microservice's repository.\n ### Best Practices\n - If you use a mono-repo approach you might want to link to the directory of the microservice instead.",
"type": "string"
},
"responsibleTeam": {
"description": "The identifier of the responsible team. Make sure all microservices governed by the same team use the same identifier in order to link them.",
"markdownDescription": "The identifier of the responsible team. Make sure all microservices governed by the same team use the same identifier in order to link them.\n ### Best Practices\n - If you have shared responsibilities for certain microservices, you might consider introducing a `SharedOwnership` team.",
"type": "string"
},
"responsibles": {
"description": "The email addresses or names of the mainly responsible people that should serve as contact persons. Make sure all microservices governed by the same responsible use the same identifier in order to link them.",
"items": {
"type": "string"
},
"markdownDescription": "The email addresses or names of the mainly responsible people that should serve as contact persons. Make sure all microservices governed by the same responsible use the same identifier in order to link them.\n ### Best Practices\n - Use a consistent tagging scheme across all microservices.\n - Using email addresses makes getting in touch easier than names.",
"type": "array"
},
"subscribedEvents": {
"description": "The events that the microservice consumes. The \"subscribedEvents\" identifier has to match a \"publishedEvents\" identifier in another microservice's msadoc.json in order to link them.",
"items": {
"type": "string"
},
"markdownDescription": "The events that the microservice consumes. The `subscribedEvents` identifier has to match a `publishedEvents` identifier in another microservice's `msadoc.json` in order to link them.\n ### Best Practices\n - Use this attribute to document asynchronous event dependencies. For synchronous APIs like HTTP or RPC use the attribute `consumedAPIs`.",
"type": "array"
},
"tags": {
"description": "A list of tags for the microservice. The tag is used as key to filter services.",
"items": {
"type": "string"
},
"markdownDescription": "A list of tags for the microservice. The `tag` is used as key to filter services.\n ### Best Practices\n - Use a consistent tagging scheme across all microservices.\n - Don't use spaces to avoid ambiguities.",
"type": "array"
},
"taskBoard": {
"description": "The link to the microservice's task board.",
"markdownDescription": "The link to the microservice's task board.\n ### Best Practices\n - If you utilize a microservice-overarching task board you might want to link to a filtered view specific to the microservice.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
} | Apache-2.0 | en |
frc971/971-Robot-Code | a1d006ee71c7c2b0cca76f8930d0ed8428c9b066 | "2022-09-15T15:51:10" | third_party/flatbuffers/tests/monster_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_Monster",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"MyGame_Example2_Monster": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_Example_Ability": {
"additionalProperties": false,
"properties": {
"distance": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Any": {
"enum": [
"NONE",
"Monster",
"TestSimpleTableWithEnum",
"MyGame_Example2_Monster"
],
"type": "string"
},
"MyGame_Example_AnyAmbiguousAliases": {
"enum": [
"NONE",
"M1",
"M2",
"M3"
],
"type": "string"
},
"MyGame_Example_AnyUniqueAliases": {
"enum": [
"NONE",
"M",
"TS",
"M2"
],
"type": "string"
},
"MyGame_Example_Color": {
"enum": [
"Red",
"Green",
"Blue"
],
"type": "string"
},
"MyGame_Example_LongEnum": {
"enum": [
"LongOne",
"LongTwo",
"LongBig"
],
"type": "string"
},
"MyGame_Example_Monster": {
"additionalProperties": false,
"description": "an example documentation comment: \"monster object\"",
"properties": {
"any_ambiguous": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
}
]
},
"any_ambiguous_type": {
"$ref": "#/definitions/MyGame_Example_AnyAmbiguousAliases"
},
"any_unique": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"any_unique_type": {
"$ref": "#/definitions/MyGame_Example_AnyUniqueAliases"
},
"co_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"enemy": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"flex": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"friendly": {
"deprecated": true,
"type": "boolean"
},
"hp": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"inventory": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"long_enum_non_enum_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"long_enum_normal_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"mana": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"name": {
"type": "string"
},
"native_inline": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"non_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"parent_namespace_test": {
"$ref": "#/definitions/MyGame_InParentNamespace"
},
"pos": {
"$ref": "#/definitions/MyGame_Example_Vec3"
},
"scalar_key_sorted_tables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"type": "array"
},
"signed_enum": {
"$ref": "#/definitions/MyGame_Example_Race"
},
"single_weak_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"test": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"test4": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test5": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test_type": {
"$ref": "#/definitions/MyGame_Example_Any"
},
"testarrayofbools": {
"items": {
"type": "boolean"
},
"type": "array"
},
"testarrayofsortedstruct": {
"items": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"type": "array"
},
"testarrayofstring": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayofstring2": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayoftables": {
"description": "an example documentation comment: this will end up in the generated code\nmultiline too",
"items": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"type": "array"
},
"testbool": {
"type": "boolean"
},
"testempty": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"testf": {
"type": "number"
},
"testf2": {
"type": "number"
},
"testf3": {
"type": "number"
},
"testhashs32_fnv1": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs32_fnv1a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs64_fnv1": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashs64_fnv1a": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashu32_fnv1": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu32_fnv1a": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1a": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testnestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"testrequirednestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_co_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_doubles": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_enums": {
"items": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"type": "array"
},
"vector_of_longs": {
"items": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"type": "array"
},
"vector_of_non_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_strong_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_weak_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"MyGame_Example_Race": {
"enum": [
"None",
"Human",
"Dwarf",
"Elf"
],
"type": "string"
},
"MyGame_Example_Referrable": {
"additionalProperties": false,
"properties": {
"id": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Stat": {
"additionalProperties": false,
"properties": {
"count": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"id": {
"type": "string"
},
"val": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_StructOfStructs": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"b": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"c": {
"$ref": "#/definitions/MyGame_Example_Ability"
}
},
"type": "object"
},
"MyGame_Example_StructOfStructsOfStructs": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_StructOfStructs"
}
},
"type": "object"
},
"MyGame_Example_Test": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"b": {
"maximum": 127,
"minimum": -128,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_TestSimpleTableWithEnum": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
}
},
"type": "object"
},
"MyGame_Example_TypeAliases": {
"additionalProperties": false,
"properties": {
"f32": {
"type": "number"
},
"f64": {
"type": "number"
},
"i16": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"i32": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"i64": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"i8": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"u16": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"u32": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"u64": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"u8": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"v8": {
"items": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"type": "array"
},
"vf64": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_Vec3": {
"additionalProperties": false,
"properties": {
"test1": {
"type": "number"
},
"test2": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"test3": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"type": "object"
},
"MyGame_InParentNamespace": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_OtherNameSpace_FromInclude": {
"enum": [
"IncludeVal"
],
"type": "string"
},
"MyGame_OtherNameSpace_TableB": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/TableA"
}
},
"type": "object"
},
"MyGame_OtherNameSpace_Unused": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
},
"type": "object"
},
"TableA": {
"additionalProperties": false,
"properties": {
"b": {
"$ref": "#/definitions/MyGame_OtherNameSpace_TableB"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
frc971/971-Robot-Code | 65541cbf748bbde2c912bd7690fb6cc0f80f4cb3 | "2022-11-09T00:22:54" | third_party/flatbuffers/tests/monster_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_Monster",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"MyGame_Example2_Monster": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_Example_Ability": {
"additionalProperties": false,
"properties": {
"distance": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Any": {
"enum": [
"NONE",
"Monster",
"TestSimpleTableWithEnum",
"MyGame_Example2_Monster"
],
"type": "string"
},
"MyGame_Example_AnyAmbiguousAliases": {
"enum": [
"NONE",
"M1",
"M2",
"M3"
],
"type": "string"
},
"MyGame_Example_AnyUniqueAliases": {
"enum": [
"NONE",
"M",
"TS",
"M2"
],
"type": "string"
},
"MyGame_Example_Color": {
"enum": [
"Red",
"Green",
"Blue"
],
"type": "string"
},
"MyGame_Example_LongEnum": {
"enum": [
"LongOne",
"LongTwo",
"LongBig"
],
"type": "string"
},
"MyGame_Example_Monster": {
"additionalProperties": false,
"description": "an example documentation comment: \"monster object\"",
"properties": {
"any_ambiguous": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
}
]
},
"any_ambiguous_type": {
"$ref": "#/definitions/MyGame_Example_AnyAmbiguousAliases"
},
"any_unique": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"any_unique_type": {
"$ref": "#/definitions/MyGame_Example_AnyUniqueAliases"
},
"co_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"double_inf_default": {
"type": "number"
},
"enemy": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"flex": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"friendly": {
"deprecated": true,
"type": "boolean"
},
"hp": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"inf_default": {
"type": "number"
},
"infinity_default": {
"type": "number"
},
"inventory": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"long_enum_non_enum_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"long_enum_normal_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"mana": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"name": {
"type": "string"
},
"nan_default": {
"type": "number"
},
"native_inline": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"negative_inf_default": {
"type": "number"
},
"negative_infinity_default": {
"type": "number"
},
"non_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"parent_namespace_test": {
"$ref": "#/definitions/MyGame_InParentNamespace"
},
"pos": {
"$ref": "#/definitions/MyGame_Example_Vec3"
},
"positive_inf_default": {
"type": "number"
},
"positive_infinity_default": {
"type": "number"
},
"scalar_key_sorted_tables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"type": "array"
},
"signed_enum": {
"$ref": "#/definitions/MyGame_Example_Race"
},
"single_weak_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"test": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"test4": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test5": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test_type": {
"$ref": "#/definitions/MyGame_Example_Any"
},
"testarrayofbools": {
"items": {
"type": "boolean"
},
"type": "array"
},
"testarrayofsortedstruct": {
"items": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"type": "array"
},
"testarrayofstring": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayofstring2": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayoftables": {
"description": "an example documentation comment: this will end up in the generated code\nmultiline too",
"items": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"type": "array"
},
"testbool": {
"type": "boolean"
},
"testempty": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"testf": {
"type": "number"
},
"testf2": {
"type": "number"
},
"testf3": {
"type": "number"
},
"testhashs32_fnv1": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs32_fnv1a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs64_fnv1": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashs64_fnv1a": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashu32_fnv1": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu32_fnv1a": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1a": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testnestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"testrequirednestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_co_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_doubles": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_enums": {
"items": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"type": "array"
},
"vector_of_longs": {
"items": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"type": "array"
},
"vector_of_non_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_strong_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_weak_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"MyGame_Example_Race": {
"enum": [
"None",
"Human",
"Dwarf",
"Elf"
],
"type": "string"
},
"MyGame_Example_Referrable": {
"additionalProperties": false,
"properties": {
"id": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Stat": {
"additionalProperties": false,
"properties": {
"count": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"id": {
"type": "string"
},
"val": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_StructOfStructs": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"b": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"c": {
"$ref": "#/definitions/MyGame_Example_Ability"
}
},
"type": "object"
},
"MyGame_Example_StructOfStructsOfStructs": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_StructOfStructs"
}
},
"type": "object"
},
"MyGame_Example_Test": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"b": {
"maximum": 127,
"minimum": -128,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_TestSimpleTableWithEnum": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
}
},
"type": "object"
},
"MyGame_Example_TypeAliases": {
"additionalProperties": false,
"properties": {
"f32": {
"type": "number"
},
"f64": {
"type": "number"
},
"i16": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"i32": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"i64": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"i8": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"u16": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"u32": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"u64": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"u8": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"v8": {
"items": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"type": "array"
},
"vf64": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_Vec3": {
"additionalProperties": false,
"properties": {
"test1": {
"type": "number"
},
"test2": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"test3": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"type": "object"
},
"MyGame_InParentNamespace": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_OtherNameSpace_FromInclude": {
"enum": [
"IncludeVal"
],
"type": "string"
},
"MyGame_OtherNameSpace_TableB": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/TableA"
}
},
"type": "object"
},
"MyGame_OtherNameSpace_Unused": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
},
"type": "object"
},
"TableA": {
"additionalProperties": false,
"properties": {
"b": {
"$ref": "#/definitions/MyGame_OtherNameSpace_TableB"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
frc971/971-Robot-Code | dac091f924316da920a238a42e7944fa80aad162 | "2022-03-22T16:35:06" | third_party/flatbuffers/tests/monster_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_Monster",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"MyGame_Example2_Monster": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_Example_Ability": {
"additionalProperties": false,
"properties": {
"distance": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"id": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Any": {
"enum": [
"NONE",
"Monster",
"TestSimpleTableWithEnum",
"MyGame_Example2_Monster"
],
"type": "string"
},
"MyGame_Example_AnyAmbiguousAliases": {
"enum": [
"NONE",
"M1",
"M2",
"M3"
],
"type": "string"
},
"MyGame_Example_AnyUniqueAliases": {
"enum": [
"NONE",
"M",
"TS",
"M2"
],
"type": "string"
},
"MyGame_Example_Color": {
"enum": [
"Red",
"Green",
"Blue"
],
"type": "string"
},
"MyGame_Example_LongEnum": {
"enum": [
"LongOne",
"LongTwo",
"LongBig"
],
"type": "string"
},
"MyGame_Example_Monster": {
"additionalProperties": false,
"description": "an example documentation comment: \"monster object\"",
"properties": {
"any_ambiguous": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
}
]
},
"any_ambiguous_type": {
"$ref": "#/definitions/MyGame_Example_AnyAmbiguousAliases"
},
"any_unique": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"any_unique_type": {
"$ref": "#/definitions/MyGame_Example_AnyUniqueAliases"
},
"co_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"enemy": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"flex": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"friendly": {
"deprecated": true,
"type": "boolean"
},
"hp": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"inventory": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"long_enum_non_enum_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"long_enum_normal_default": {
"$ref": "#/definitions/MyGame_Example_LongEnum"
},
"mana": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"name": {
"type": "string"
},
"native_inline": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"non_owning_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"parent_namespace_test": {
"$ref": "#/definitions/MyGame_InParentNamespace"
},
"pos": {
"$ref": "#/definitions/MyGame_Example_Vec3"
},
"scalar_key_sorted_tables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"type": "array"
},
"signed_enum": {
"$ref": "#/definitions/MyGame_Example_Race"
},
"single_weak_reference": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"test": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"test4": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test5": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test_type": {
"$ref": "#/definitions/MyGame_Example_Any"
},
"testarrayofbools": {
"items": {
"type": "boolean"
},
"type": "array"
},
"testarrayofsortedstruct": {
"items": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"type": "array"
},
"testarrayofstring": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayofstring2": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayoftables": {
"description": "an example documentation comment: this will end up in the generated code\nmultiline too",
"items": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"type": "array"
},
"testbool": {
"type": "boolean"
},
"testempty": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"testf": {
"type": "number"
},
"testf2": {
"type": "number"
},
"testf3": {
"type": "number"
},
"testhashs32_fnv1": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs32_fnv1a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"testhashs64_fnv1": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashs64_fnv1a": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"testhashu32_fnv1": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu32_fnv1a": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testhashu64_fnv1a": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"testnestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"testrequirednestedflatbuffer": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_co_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_doubles": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_enums": {
"items": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"type": "array"
},
"vector_of_longs": {
"items": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"type": "array"
},
"vector_of_non_owning_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
},
"vector_of_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_strong_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_weak_references": {
"items": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"MyGame_Example_Race": {
"enum": [
"None",
"Human",
"Dwarf",
"Elf"
],
"type": "string"
},
"MyGame_Example_Referrable": {
"additionalProperties": false,
"properties": {
"id": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_Stat": {
"additionalProperties": false,
"properties": {
"count": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"id": {
"type": "string"
},
"val": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_StructOfStructs": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"b": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"c": {
"$ref": "#/definitions/MyGame_Example_Ability"
}
},
"type": "object"
},
"MyGame_Example_Test": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"b": {
"maximum": 127,
"minimum": -128,
"type": "integer"
}
},
"type": "object"
},
"MyGame_Example_TestSimpleTableWithEnum": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
}
},
"type": "object"
},
"MyGame_Example_TypeAliases": {
"additionalProperties": false,
"properties": {
"f32": {
"type": "number"
},
"f64": {
"type": "number"
},
"i16": {
"maximum": 32767,
"minimum": -32768,
"type": "integer"
},
"i32": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"i64": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"i8": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"u16": {
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"u32": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"u64": {
"maximum": 18446744073709551615,
"minimum": 0,
"type": "integer"
},
"u8": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"v8": {
"items": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"type": "array"
},
"vf64": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_Vec3": {
"additionalProperties": false,
"properties": {
"test1": {
"type": "number"
},
"test2": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"test3": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"type": "object"
},
"MyGame_InParentNamespace": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_OtherNameSpace_FromInclude": {
"enum": [
"IncludeVal"
],
"type": "string"
},
"MyGame_OtherNameSpace_TableB": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/TableA"
}
},
"type": "object"
},
"MyGame_OtherNameSpace_Unused": {
"additionalProperties": false,
"properties": {
"a": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
}
},
"type": "object"
},
"TableA": {
"additionalProperties": false,
"properties": {
"b": {
"$ref": "#/definitions/MyGame_OtherNameSpace_TableB"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
frc971/971-Robot-Code | dac091f924316da920a238a42e7944fa80aad162 | "2022-03-22T16:35:06" | third_party/flatbuffers/tests/arrays_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_ArrayTable",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"MyGame_Example_ArrayStruct": {
"additionalProperties": false,
"properties": {
"a": {
"type": "number"
},
"b": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"maxItems": 15,
"minItems": 15,
"type": "array"
},
"c": {
"maximum": 127,
"minimum": -128,
"type": "integer"
},
"d": {
"items": {
"$ref": "#/definitions/MyGame_Example_NestedStruct"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"e": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"f": {
"items": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_ArrayTable": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_ArrayStruct"
}
},
"type": "object"
},
"MyGame_Example_NestedStruct": {
"additionalProperties": false,
"properties": {
"a": {
"items": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"b": {
"$ref": "#/definitions/MyGame_Example_TestEnum"
},
"c": {
"items": {
"$ref": "#/definitions/MyGame_Example_TestEnum"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"d": {
"items": {
"maximum": 9223372036854775807,
"minimum": -9223372036854775808,
"type": "integer"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_TestEnum": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
}
}
} | Apache-2.0 | en |
frc971/971-Robot-Code | 4ac96a8f593b84de2773be5ac458656a51d9bc17 | "2019-08-15T03:25:25" | third_party/flatbuffers/tests/monster_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_Monster",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"MyGame_Example2_Monster": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_Example_Ability": {
"additionalProperties": false,
"properties": {
"distance": {
"type": "number"
},
"id": {
"type": "number"
}
},
"type": "object"
},
"MyGame_Example_Any": {
"enum": [
"NONE",
"Monster",
"TestSimpleTableWithEnum",
"MyGame_Example2_Monster"
],
"type": "string"
},
"MyGame_Example_AnyAmbiguousAliases": {
"enum": [
"NONE",
"M1",
"M2",
"M3"
],
"type": "string"
},
"MyGame_Example_AnyUniqueAliases": {
"enum": [
"NONE",
"M",
"TS",
"M2"
],
"type": "string"
},
"MyGame_Example_Color": {
"enum": [
"Red",
"Green",
"Blue"
],
"type": "string"
},
"MyGame_Example_Monster": {
"additionalProperties": false,
"description": " an example documentation comment: monster object",
"properties": {
"any_ambiguous": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_Monster"
}
]
},
"any_ambiguous_type": {
"$ref": "#/definitions/MyGame_Example_AnyAmbiguousAliases"
},
"any_unique": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"any_unique_type": {
"$ref": "#/definitions/MyGame_Example_AnyUniqueAliases"
},
"co_owning_reference": {
"type": "number"
},
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"enemy": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"flex": {
"items": {
"type": "number"
},
"type": "array"
},
"friendly": {
"type": "boolean"
},
"hp": {
"type": "number"
},
"inventory": {
"items": {
"type": "number"
},
"type": "array"
},
"mana": {
"type": "number"
},
"name": {
"type": "string"
},
"non_owning_reference": {
"type": "number"
},
"parent_namespace_test": {
"$ref": "#/definitions/MyGame_InParentNamespace"
},
"pos": {
"$ref": "#/definitions/MyGame_Example_Vec3"
},
"single_weak_reference": {
"type": "number"
},
"test": {
"anyOf": [
{
"$ref": "#/definitions/MyGame_Example_Monster"
},
{
"$ref": "#/definitions/MyGame_Example_TestSimpleTableWithEnum"
},
{
"$ref": "#/definitions/MyGame_Example2_Monster"
}
]
},
"test4": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test5": {
"items": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"type": "array"
},
"test_type": {
"$ref": "#/definitions/MyGame_Example_Any"
},
"testarrayofbools": {
"items": {
"type": "boolean"
},
"type": "array"
},
"testarrayofsortedstruct": {
"items": {
"$ref": "#/definitions/MyGame_Example_Ability"
},
"type": "array"
},
"testarrayofstring": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayofstring2": {
"items": {
"type": "string"
},
"type": "array"
},
"testarrayoftables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Monster"
},
"type": "array"
},
"testbool": {
"type": "boolean"
},
"testempty": {
"$ref": "#/definitions/MyGame_Example_Stat"
},
"testf": {
"type": "number"
},
"testf2": {
"type": "number"
},
"testf3": {
"type": "number"
},
"testhashs32_fnv1": {
"type": "number"
},
"testhashs32_fnv1a": {
"type": "number"
},
"testhashs64_fnv1": {
"type": "number"
},
"testhashs64_fnv1a": {
"type": "number"
},
"testhashu32_fnv1": {
"type": "number"
},
"testhashu32_fnv1a": {
"type": "number"
},
"testhashu64_fnv1": {
"type": "number"
},
"testhashu64_fnv1a": {
"type": "number"
},
"testnestedflatbuffer": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_co_owning_references": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_doubles": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_enums": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"vector_of_longs": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_non_owning_references": {
"items": {
"type": "number"
},
"type": "array"
},
"vector_of_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_strong_referrables": {
"items": {
"$ref": "#/definitions/MyGame_Example_Referrable"
},
"type": "array"
},
"vector_of_weak_references": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"MyGame_Example_Referrable": {
"additionalProperties": false,
"properties": {
"id": {
"type": "number"
}
},
"type": "object"
},
"MyGame_Example_Stat": {
"additionalProperties": false,
"properties": {
"count": {
"type": "number"
},
"id": {
"type": "string"
},
"val": {
"type": "number"
}
},
"type": "object"
},
"MyGame_Example_Test": {
"additionalProperties": false,
"properties": {
"a": {
"type": "number"
},
"b": {
"type": "number"
}
},
"type": "object"
},
"MyGame_Example_TestSimpleTableWithEnum": {
"additionalProperties": false,
"properties": {
"color": {
"$ref": "#/definitions/MyGame_Example_Color"
}
},
"type": "object"
},
"MyGame_Example_TypeAliases": {
"additionalProperties": false,
"properties": {
"f32": {
"type": "number"
},
"f64": {
"type": "number"
},
"i16": {
"type": "number"
},
"i32": {
"type": "number"
},
"i64": {
"type": "number"
},
"i8": {
"type": "number"
},
"u16": {
"type": "number"
},
"u32": {
"type": "number"
},
"u64": {
"type": "number"
},
"u8": {
"type": "number"
},
"v8": {
"items": {
"type": "number"
},
"type": "array"
},
"vf64": {
"items": {
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_Vec3": {
"additionalProperties": false,
"properties": {
"test1": {
"type": "number"
},
"test2": {
"$ref": "#/definitions/MyGame_Example_Color"
},
"test3": {
"$ref": "#/definitions/MyGame_Example_Test"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"type": "object"
},
"MyGame_InParentNamespace": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"MyGame_OtherNameSpace_FromInclude": {
"enum": [
"IncludeVal"
],
"type": "string"
},
"MyGame_OtherNameSpace_TableB": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/TableA"
}
},
"type": "object"
},
"MyGame_OtherNameSpace_Unused": {
"additionalProperties": false,
"properties": {
"a": {
"type": "number"
}
},
"type": "object"
},
"TableA": {
"additionalProperties": false,
"properties": {
"b": {
"$ref": "#/definitions/MyGame_OtherNameSpace_TableB"
}
},
"type": "object"
}
}
} | Apache-2.0 | en |
frc971/971-Robot-Code | 4ac96a8f593b84de2773be5ac458656a51d9bc17 | "2019-08-15T03:25:25" | third_party/flatbuffers/tests/arrays_test.schema.json | 62 | 2024-05-27T22:48:16.627468Z | {
"$ref": "#/definitions/MyGame_Example_ArrayTable",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"MyGame_Example_ArrayStruct": {
"additionalProperties": false,
"properties": {
"a": {
"type": "number"
},
"b": {
"items": {
"type": "number"
},
"maxItems": 15,
"minItems": 15,
"type": "array"
},
"c": {
"type": "number"
},
"d": {
"items": {
"$ref": "#/definitions/MyGame_Example_NestedStruct"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
}
},
"type": "object"
},
"MyGame_Example_ArrayTable": {
"additionalProperties": false,
"properties": {
"a": {
"$ref": "#/definitions/MyGame_Example_ArrayStruct"
}
},
"type": "object"
},
"MyGame_Example_NestedStruct": {
"additionalProperties": false,
"properties": {
"a": {
"items": {
"type": "number"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"b": {
"$ref": "#/definitions/MyGame_Example_TestEnum"
},
"c": {
"$ref": "#/definitions/MyGame_Example_TestEnum",
"maxItems": 2,
"minItems": 2
}
},
"type": "object"
},
"MyGame_Example_TestEnum": {
"enum": [
"A",
"B",
"C"
],
"type": "string"
}
}
} | Apache-2.0 | en |
coveo/cli | 05ac35e345a722c6d1102891508ebeacdbe6f9bd | "2022-08-25T15:35:23" | packages/cli/core/src/lib/snapshot/pullModel/validation/model.schema.json | 21 | 2024-05-28T05:00:44.340017Z | {
"$id": "https://github.com/coveo/cli/blob/master/packages/cli/core/src/lib/snapshot/pullModelValidation/model.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "A configuration to pull snaphots",
"properties": {
"$schema": {
"type": "string"
},
"includeChildrenResources": {
"type": "boolean"
},
"orgId": {
"type": "string"
},
"resourcesToExport": {
"additionalProperties": false,
"type": "object"
}
},
"required": [
"resourcesToExport"
],
"title": "SnapshotPullModel",
"type": "object"
} | Apache-2.0 | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/instrumentation_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the setup or instrumentation as well as its parameters that were used to measure BRDF data presented in the file.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to instrumentation used for BRDF measurement.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding setup or instrumentation used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"detection_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"title": "detection",
"type": "object"
},
"firmware_version": {
"description": "Version of the firmware used to operate the instrument or system during the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "firmware_version",
"type": "string"
},
"illumination_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/illumination_system_json_schema_v1.0.json",
"description": "An object with keys describing illumination source, relevant optical components and illumination beam properties.",
"title": "illumination",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the instrument or system used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the instrument or system that was used for the measurement of BRDF data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the instrument or system that was used for the measurement of BRDF data presented within the file.",
"title": "name",
"type": "string"
},
"operation_type": {
"description": "The key describing whether instrument performs measurements absolutely or relatively. Can have string values \"absolute\" and \"relative\".",
"oneOf": [
{
"const": "absolute"
},
{
"const": "relative"
}
],
"title": "operation_type",
"type": "string"
},
"operator_name": {
"description": "Name of the person who performed BRDF measurements presented within file as a string.",
"title": "operator_name",
"type": "string"
},
"reference_info": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"description": "An object describing reference sample and related data used for relative BRDF measurements.",
"title": "reference_info",
"type": "object"
},
"serial_number": {
"description": "Serial number of the instrument or system that was used for the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "serial_number",
"type": "string"
}
},
"required": [
"name",
"illumination",
"detection"
],
"title": "instrumentation",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 0b2edf86640c160bb42f3a2876148e716582539d | "2021-12-12T21:22:01" | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties/fields that allow to describe variables of BRDF function and provide their values alongside BRDF values themselves.",
"properties": {
"BRDF": {
"additionalProperties": false,
"description": "An object describing and providing the bidirectional reflectance distribution function \"BRDF\" values as defined by F. E. Nicodemus. I.e. BRDF values are measured in sr^\u22121 (1/sr) and can vary from 0 sr^\u22121 to inf. sr^\u22121.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"BRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of \"BRDF\" values. It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of \"BRDF\" values as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of \"BRDF\" values as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the \"BRDF\" values. Allowed values are strings \"1/sr\" or \"sr^-1\".",
"enum": [
"1/sr",
"sr^-1"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of measured or simulated \"BRDF\" values corresponding to set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "BRDF",
"type": "object"
},
"adhoc_variables": {
"additionalProperties": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields. It is also advised to place \"adhoc_variable\" object under such \"adhoc_variables\" key that would shortly describe the nature of the user defined variable.",
"title": "adhoc_variable",
"type": "object"
},
"description": "An object containing properties/fields describing user defined BRDF variables. For example, solid angle or illumination/observation spot spatial coordinates if they were varied during BRDF measurements. Most successful variable definitions might become standard definitions and will be included to default parameters of future versions of universal BRDF file format schema.",
"title": "adhoc_variables",
"type": "object"
},
"phi_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence azimuthal angle \"phi_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence azimuthal angle \"phi_i\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to illumination incidence azimuthal angle \"phi_i\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence azimuthal angle \"phi_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence azimuthal angle.",
"description": "The field providing the short description of the \"phi_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_i",
"description": "The field providing the short name of the illumination light incidence azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence azimuthal angle \"phi_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence azimuthal angle \"phi_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_i",
"type": "object"
},
"phi_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation azimuthal angle \"phi_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation azimuthal angle \"phi_r\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to reflected light observation azimuthal angle \"phi_r\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation azimuthal angle \"phi_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation azimuthal angle.",
"description": "The field providing the short description of the \"phi_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_r",
"description": "The field providing the short name of the reflected light observation azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation azimuthal angle \"phi_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation azimuthal angle \"phi_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"index",
"type",
"unit"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_r",
"type": "object"
},
"polarization_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the illumination light polarization state \"polarization_i\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of incidence (https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of incidence is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of incidence and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is illuminated under 0\u00b0 illumination zenith angle \"theta_i\", then it is advised to define plane of incidence using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_i\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light polarization state \"polarization_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light polarization state.",
"description": "The field providing the short description of the \"polarization_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_i",
"description": "The field providing the short name of the illumination light polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe illumination light polarization state \"polarization_i\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light polarization state \"polarization_i\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the illumination light polarization state \"polarization_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_i",
"type": "object"
},
"polarization_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the reflected light observation polarization state \"polarization_r\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of reflectance (i.e. plane defined by the direction of reflectance observation and measurement sample's normal similarly to the plane of incidence - https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of reflectance is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of reflectance and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is observed under 0\u00b0 reflectance observation zenith angle \"theta_r\", then it is advised to define plane of reflectance using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_r\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation polarization state \"polarization_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light observation polarization state.",
"description": "The field providing the short description of the \"polarization_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_r",
"description": "The field providing the short name of the reflected light observation polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe reflected light observation polarization state \"polarization_r\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation polarization state \"polarization_r\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"values",
"units"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the reflected light observation polarization state \"polarization_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_r",
"type": "object"
},
"theta_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence zenith angle \"theta_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence zenith angle \"theta_i\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence zenith angle \"theta_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence zenith angle.",
"description": "The field providing the short description of the \"theta_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_i",
"description": "The field providing the short name of the illumination light incidence zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence zenith angle \"theta_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence zenith angle \"theta_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to 2/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_i",
"type": "object"
},
"theta_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation zenith angle \"theta_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation zenith angle \"theta_r\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation zenith angle \"theta_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation zenith angle.",
"description": "The field providing the short description of the \"theta_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_r",
"description": "The field providing the short name of the reflected light observation zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation zenith angle \"theta_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation zenith angle \"theta_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to 2/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_r",
"type": "object"
},
"uBRDF": {
"additionalProperties": false,
"description": "An object that describes the variable corresponding to non-constant uncertainty of bidirectional reflectance distribution function values \"uBRDF\". I.e. BRDF associated uncertainty that varies with BRDF function parameters/variables. It is a complex quantity that might be affected by the uncertainties of all the variables used for BRDF estimation and most probably is unique for different measurement instruments and simulation models. BRDF uncertainty should be presented in sr^-1 (1/sr) if it is absolute or in % if relative.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to uncertainty of the bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Uncertainty of bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"uBRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the uncertainty of bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"unit": {
"description": "The field that allows to specify measurement unit uncertainty of bidirectional reflectance distribution function values \"uBRDF\" as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the measured or simulated \"BRDF\" uncertainty estimated for each set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "uBRDF",
"type": "object"
},
"wavelength_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light wavelength \"wavelength_i\" and provide its values. This parameter is relevant for spectral BRDF measurements where monochromatic illumination is used and its wavelength is set before the light hits the sample. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light wavelength \"wavelength_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light wavelength.",
"description": "The field providing the short description of the \"wavelength_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_i",
"description": "The field providing the short name of the illumination light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light wavelength \"wavelength_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light wavelength \"wavelength_i\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light wavelength \"wavelength_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_i",
"type": "object"
},
"wavelength_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the observed reflected light wavelength \"wavelength_r\" and provide its values. This parameter is relevant for spectral BRDF measurements where light reflected from the sample is spectrally resolved prior its detection by the sensor. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to the observed reflected light wavelength \"wavelength_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Observed reflected light wavelength.",
"description": "The field providing the short description of the \"wavelength_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_r",
"description": "The field providing the short name of the observed reflected light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the observed reflected light wavelength \"wavelength_r\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the observed reflected light wavelength \"wavelength_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_r",
"type": "object"
}
},
"required": [
"theta_i",
"phi_i",
"theta_r",
"phi_r",
"BRDF"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/aperture_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties of the aperture that is a part of the instrument used for BRDF measurement.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the aperture that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding aperture as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding aperture used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the aperture depending on its shape.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the aperture as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material from which aperture was produced as a text (i.e. string).",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the aperture given by manufacturr as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the aperture in a free form as a text (i.e. string).",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the aperture used for BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"type": {
"description": "Type of aperture used for BRDF measurement. For example, \"slit\", \"iris\", \"diaphragm\" etc. A a a text (i.e. string)",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"shape",
"dimensions"
],
"title": "aperture",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/brdf_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/brdf_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A JSON schema for automatic validation of Universal BRDF data format proposed by BiRD project consortium in 2021",
"properties": {
"data": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"description": "an object with keys related to definition of BRDF function, variable properties of BRDF data and BRDF values themselves",
"title": "data",
"type": "object"
},
"metadata": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and evironment. It also contains a globaly unique dataset identifier, specifices the data type, file name and records a timestamp of a measurement or simulation",
"title": "metadata",
"type": "object"
}
},
"required": [
"metadata",
"data"
],
"title": "Universal BRDF data format schema",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 11fe0190f2e38e8dc8697a37e88eda02ff64ccc0 | "2022-01-14T19:21:25" | BRDF_JSON_schema/instrumentation_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the setup or instrumentation as well as its parameters that were used to measure BRDF data presented in the file.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to instrumentation used for BRDF measurement.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding setup or instrumentation used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"detection_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"title": "detection",
"type": "object"
},
"firmware_version": {
"description": "Version of the firmware used to operate the instrument or system during the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "firmware_version",
"type": "string"
},
"illumination_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/illumination_system_json_schema_v1.0.json",
"description": "An object with keys describing illumination source, relevant optical components and illumination beam properties.",
"title": "illumination",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the instrument or system used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the instrument or system that was used for the measurement of BRDF data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the instrument or system that was used for the measurement of BRDF data presented within the file.",
"title": "name",
"type": "string"
},
"operation_type": {
"description": "The key describing whether instrument performs measurements absolutely or relatively. Can have string values \"absolute\" and \"relative\".",
"enum": [
"absolute",
"relative"
],
"title": "operation_type",
"type": "string"
},
"operator_name": {
"description": "Name of the person who performed BRDF measurements presented within file as a string.",
"title": "operator_name",
"type": "string"
},
"reference_info": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"description": "An object describing reference sample and related data used for relative BRDF measurements.",
"title": "reference_info",
"type": "object"
},
"serial_number": {
"description": "Serial number of the instrument or system that was used for the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "serial_number",
"type": "string"
}
},
"required": [
"name",
"illumination_system",
"detection_system"
],
"title": "instrumentation",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | cf47e30c477bee57d0f23e88937012141314dc7c | "2022-02-10T18:14:00" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and environment. It also contains a globally unique dataset identifier, specifies the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding BRDF data presented within the file. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A short description in the form of text (i.e. string) of the the measured or simulated BRDF data set presented within the file. For example, it can be brief information of what sample was measured, for what purpose and with which simulation model or instrument without giving all possible specific information. The idea of this field is to give short overview of the presented BRDF data in a way that user could understand with what kind of information he is dealing with without going into details presented in other \"metadata\" objects.",
"title": "description",
"type": "string"
},
"environment": {
"description": "By default it is an object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc. However, if data was acquired with the help of simulation/model, the \"environment\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"type": "object"
}
],
"title": "environment"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in URI format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"description": "By default it is an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. However, if data was acquired with the help of simulation/model, the \"instrumentation\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"type": "object"
}
],
"title": "instrumentation"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "The field to describe data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"enum": [
"simulation",
"measurement"
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "provenance",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"description": "An object with keys describing the virtual or actual sample used to produce BRDF data.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL link to schema of universal BRDF file format which name also specifies the schema version. Value has to be a string in URI format. Note that URL is part of uri (universal resource identifier (URI), according to RFC3986)",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"description": "By default it is an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. However, if data was acquired through the measurement without the help of any additional software the \"software\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"type": "object"
}
],
"title": "software"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"timestamp",
"provenance",
"description",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/software_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the software as well as the mathematical/physical simulation model and its parameters used to produce or process BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"software\" object) describing any information relevant to the software and simulation model that were used to produce or process BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"author": {
"description": "Person or company name that developed the software used to produce or process BRDF data as a text (i.e. string).",
"title": "author",
"type": "string"
},
"comments": {
"description": "A section that allows to add any additional information regarding the software and simulation model that were used to produce or process BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allow to refer to any external information related to the software and simulation model that were used to produce or process BRDF data presented in the file. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the the software used to produce or process BRDF data as a text (i.e. string). For exmple, \"Ray-tracing software for optical reflectance simulation.\" or \"Matlab script for calculation BRDF values and its uncertainty from measurement results and known instrumental parameters.\"",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "name",
"type": "string"
},
"simulation_model": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_json_schema_v1.0.json",
"description": "An object describing physical or mathematical simulation model that was used to generate BRDF values presented in the file.",
"title": "simulation_model",
"type": "object"
},
"version": {
"description": "Version of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "version",
"type": "string"
}
},
"required": [
"name"
],
"title": "software"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/wavelength_selectors_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing optical components that were used to select/filter specific wavelength or wavelength ranges from incoming radiation as well as properties and settings these components.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the wavelength selecting optical elements and devices that cannot be presented within \"wavelength_selectors\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A field for providing any additional information regarding wavelength selecting optical elements and devices as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"monochromator": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/monochromator_json_schema_v1.0.json",
"description": "The object describing properties and settings of the monochromator used for BRDF measurements.",
"title": "monochromator",
"type": "object"
},
"optical_filters": {
"description": "An array of \"optical_filter\" objects each describing the filters that were used to define illumination or collected light spectral properties during BRDF measurement.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/optical_filter_json_schema_v1.0.json",
"description": "The \"optical_filter\" object describing properties of the optical filter used for BRDF measurement.",
"title": "optical_filter",
"type": "object"
},
"title": "optical_filters",
"type": "array"
}
},
"required": [],
"title": "wavelength_selectors",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 7ce6c1790822d3c9c5e702f13de59cb0139d2e16 | "2021-12-06T15:32:41" | BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields.",
"properties": {
"comments": {
"description": "The field allowing to provide any additional and occasional information relevant to user-defined variable as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"description": "The field that allows to describe user-defined variable and its definition in a text (i.e. string) form. This field should be always present.",
"title": "description",
"type": "string"
},
"name": {
"description": "The field allowing to provide a short name as a string that would briefly describe the nature of the user-defined variable. This field is not demanded, but might be useful if key under which \"adhoc_variable\" object is stored is not sufficient for the same purpose.",
"title": "name",
"type": "string"
},
"type": {
"description": "The field allowing to specify user-defined variable values' presentation type as for, example \"string\", \"number\", \"integer\", \"array of strings\", \"array of numbers\", \"array of integers\" or \"array of arrays of string/number/integer\" etc.",
"title": "type",
"type": "string"
},
"uncertainty": {
"description": "An object that allows to define non-varying uncertainty of the user-defined variable. The field is optional. It can contain",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the user-defined variable as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
]
},
{
"additionalProperties": false,
"properties": {
"units": {
"description": "Array of measurement units of the non-varying uncertainties of the vectorized user-defined variable as a number.",
"items": {
"description": "Measurement unit of the single vector element of the non-varying uncertainty of the vectorized user-defined variable as a number.",
"type": "number"
},
"title": "units",
"type": "array"
},
"values": {
"description": "Array of numerical values of the non-varying uncertainties of the vectorized user-defined variable as a number.",
"items": {
"description": "Numerical value of the single vector element of the non-varying uncertainty of the vectorized user-defined variable as a number.",
"type": "number"
},
"title": "value",
"type": "array"
}
},
"required": [
"values",
"units"
]
}
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"values": {
"description": "The field for storing array with values of user-defined variable. Array can have any type of entries except \"objects\". \"type\" of entry should be specified in the dedicated field.",
"items": {
"not": {
"type": "object"
}
},
"title": "values",
"type": "array"
}
},
"required": [
"description",
"unit",
"type",
"values"
],
"title": "adhoc_variable",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/environment_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the environmental conditions during BRDF measurements that cannot be presented within \"environment\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding environmental conditions during BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding environmental conditions during BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"pressure": {
"additionalProperties": false,
"description": "An object describing pressure within the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\", \"psi\" or \"%\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\" and \"psi\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "pressure",
"type": "object"
},
"relative_humidity": {
"additionalProperties": false,
"description": "An object describing relative humidity of the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "relative_humidity",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing ambient temperature of the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"else": {
"properties": {
"value": {
"minimum": 0
}
}
},
"if": {
"properties": {
"unit": {
"const": "\u00b0C"
}
}
},
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the ambient temperature of the environment in which measurement sample's BRDF was measured as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the ambient temperature of the environment in which measurement sample's BRDF was measured as a number that can have positive and negative values. In \"\u00b0C\" units the minimum allowed value is \u2212273.15 (i.e. x \u2265 -273.5), while in \"K\" and \"kK\" minimum allowed value is 0 (i.e. x \u2265 0).",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"then": {
"properties": {
"value": {
"minimum": -273.15
}
}
},
"title": "temperature",
"type": "object"
}
},
"required": [
"temperature"
],
"title": "environment",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/source_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/source_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes illumination source that was used for BRDF measurements.",
"oneOf": [
{
"required": [
"name",
"type",
"power",
"wl_range"
]
},
{
"required": [
"name",
"type",
"power",
"central_wl"
]
}
],
"properties": {
"CIE_notation": {
"description": "Field that allows to classify light source according to CIE abbreviations for standard illuminants. It accommodates text (i.e.string) values corresponding only to CIE abbreviations. For information about values see https://en.wikipedia.org/wiki/Standard_illuminant.",
"enum": [
"A",
"B",
"C",
"D50",
"D55",
"D65",
"D75",
"D93",
"E",
"F1",
"F2",
"F3",
"F4",
"F5",
"F6",
"F7",
"F8",
"F9",
"F10",
"F11",
"F12",
"LED-B1",
"LED-B2",
"LED-B3",
"LED-B4",
"LED-B5",
"LED-B1",
"LED-BH1",
"LED-RGB1",
"LED-V2"
],
"title": "CIE_notation",
"type": "string"
},
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination source of the instrument that cannot be presented within \"source\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "Property describing the central wavelength of illumination light source. It is most relevant for lasers and narrow-band LEDs. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source central wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"color_temperature": {
"additionalProperties": false,
"description": "The field allowing to specify color temperature of black-body radiator if it was used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source color temperature as a string that can have values \"K\" or \"kK\".",
"pattern": "^[k]?K$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source color temperature as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "color_temperature",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding illumination source that was used for BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding light source used for BRDF measurements. Array of string URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "The property that allows to specify the manufacturer of the light source that used for BRDF measurements. For example, company or workshop name written as a text (i.e.string)",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "The property that allows to specify the model of the illumination source that was used for BRDF measurements. It can be written as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the light source that was used for BRDF measurements. Can be written in a free form as a text (string).",
"title": "name",
"type": "string"
},
"operating_current": {
"additionalProperties": false,
"description": "An object describing the current at which illumination source was operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\" or \"GA\".",
"pattern": "^[pn\u03bcmkMG]?A$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating current as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_current",
"type": "object"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light source was operated. Might be relevant in case of cooled light sources or lasers/LEDs which central wavelength can change with temperature. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating temperature as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"operating_voltage": {
"additionalProperties": false,
"description": "An object describing the voltage at which illumination source was operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"pattern": "^[pn\u03bcmkMG]?V$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating voltage as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_voltage",
"type": "object"
},
"power": {
"additionalProperties": false,
"description": "The property describing integral power of the illumination source in power units like W, kW, mW etc. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"pattern": "^[GMkm\u03bcnp]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source power as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "power",
"type": "object"
},
"type": {
"description": "The field that specifies what type of illumination source was used for BRDF measurements. For example it can be laser, incandescent lamp, black-body, LED etc. String values are allowed.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "An object allowing to specify the wavelength range within which illumination source radiates. Most relevant for wide-band sources as incandescent lamps, fluorescent lamps, black-bodies etc. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the illumination source longest wavelength as a number.",
"title": "value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the illumination source shortest wavelength as a number.",
"title": "value",
"type": "number"
},
"unit": {
"description": "Unit of the illumination source shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"title": "source",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/illumination_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/illumination_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing illumination system, illumination source, relevant optical components and illumination beam properties.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination system of the instrument that cannot be presented within \"illumination\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"beam": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/beam_json_schema_v1.0.json",
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"title": "beam",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding instrument illumination system as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination system used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Field for providing manufacturer of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_manufacturer",
"type": "string"
},
"model": {
"description": "Field for providing model of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_model",
"type": "string"
},
"name": {
"description": "Field for providing name of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of illumination light used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to produce illumination with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array"
},
"source": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/source_json_schema_v1.0.json",
"description": "An object that describes source of the illumination used for BRDF measurements.",
"title": "source",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges from illumination source radiation as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"source",
"beam"
],
"title": "illumination_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/optical_filter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "The \"optical_filter\" object describes properties of a single optical filter that was used during BRDF measurements. Note that the same object describes optical filters integrated to illumination or detection systems.",
"oneOf": [
{
"required": [
"name",
"type",
"cut_on_wl"
]
},
{
"required": [
"name",
"type",
"cut_off_wl"
]
},
{
"required": [
"name",
"type",
"wl_range"
]
},
{
"required": [
"name",
"type",
"central_wl",
"transmission_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical filter placed in in the path of light of illumination source that cannot be presented within \"filter\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"avg_transmittance": {
"additionalProperties": false,
"description": "Average transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average transmittance value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "avg_transmittance",
"type": "object"
},
"blocking_avg": {
"additionalProperties": false,
"description": "Average blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "blocking_avg",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "The central transmission wavelength of the of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter central transmission wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter central transmission wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter central transmission wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter central transmission wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"comments": {
"description": "An object that allows to provide any additional information regarding used for BRDF measurements as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"cut_off_wl": {
"additionalProperties": false,
"description": "A cut-off wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-off wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-off wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-off wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-off wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_off_wl",
"type": "object"
},
"cut_on_wl": {
"additionalProperties": false,
"description": "A cut-on wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-on wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-on wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-on wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-on wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_on_wl",
"type": "object"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical filter is designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the the uncertainty of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding optical filter used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "material",
"type": "string"
},
"max_blocking": {
"additionalProperties": false,
"description": "Maximal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_blocking"
},
"max_transmittance": {
"additionalProperties": false,
"description": "Maximal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal transmittance value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_transmittance",
"type": "object"
},
"min_blocking": {
"additionalProperties": false,
"description": "Minimal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_blocking"
},
"min_transmittance": {
"additionalProperties": false,
"description": "Minimal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal transmittance value as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_transmittance",
"type": "object"
},
"model": {
"description": "Model of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "name",
"type": "string"
},
"transmittance_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of the spectral transmission range of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's transmission FWHM as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter's transmission FWHM as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter's transmission FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's transmission FWHM as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmittance_FWHM",
"type": "object"
},
"type": {
"description": "Type of an optical filter used for BRDF measurements. For example, \"interference filter\", \"neutral density filter\", \"absorptive filter\" etc. as a text (i.e.string).",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "The field describing transmission wavelength range of the optical filter used for BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the optical filter's transmission longest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the optical filter's transmission shortest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the optical filter's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "optical_filter",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/sensor_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical sensor used for BRDF measurements that cannot be presented within \"sensor\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bias_voltage": {
"additionalProperties": false,
"description": "An object describing bias voltage applied applied to the optical sensor during BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the bias voltage applied applied to the optical sensor as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\" or \"%\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the bias voltage applied applied to the optical sensor as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bias_voltage",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding optical sensor used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical sensor is designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximal optical power at which optical sensor is designed to be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical sensor is designed to be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"dark_signal": {
"additionalProperties": false,
"description": "An object describing the level of signal when sensor is not exposed to any radiation (in Ampers (A) or Volts (V)). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical sensor's dark current as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of uncertainty of the the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's dark current as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "dark_signal",
"type": "object"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding optical sensor used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the photosensitive part of the sensor included in BRDF measurement set-up.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"linearity": {
"additionalProperties": false,
"description": "An object describing the maximal ratio between responsivities around different optical powers that sensor can sense in case of fixed detection wavelength. It is defined as min_responsivity / max_responsivity for power range used for BRDF measurements. \"nonlinearity\" object has keys keys \"value\" and \"unit\"",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical sensor's linearity as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's linearity as a positive number from 0 to 1 (or 0 to 100 if in \"%\")..",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "linearity",
"type": "object"
},
"linearity_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which linearity of the sensor is provided in the \"linearity\" field/object. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which linearity of the sensor is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which linearity of the sensor is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which linearity of the sensor is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which linearity of the sensor is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity_wl",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Light sensing material used in optical sensor included in BRDF measurement set-up as text (i.e. string). For example \"Si\", \"InGaAs\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "name",
"type": "string"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light sensor was operated during BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the temperature at which light sensor was operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature at which light sensor was operated as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"power_range": {
"additionalProperties": false,
"description": "An object describing the optical power range in which optical sensor can be usually applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the highest optical power sensor can detect as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the lowest optical power sensor can detect as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the lowest and highest power that optical sensor can detect as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "power_range",
"type": "object"
},
"responsivity": {
"additionalProperties": false,
"description": "An object describing typical for the wavelength specified in \"responsivity_wl\" object or average responsivity of optical sensor within the whole spectral response range in A/W. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the typical or average responsivity of optical sensor as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the set typical or average responsivity of optical sensor as a string that can have values \"mA/mW\", \"A/W\" or \"%\".",
"enum": [
"mA/mW",
"A/W",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the set typical or average responsivity of optical sensor as a string that can have values \"mA/mW\" or \"A/W\".",
"enum": [
"mA/mW",
"A/W"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the typical or average responsivity of optical sensor as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity",
"type": "object"
},
"responsivity_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which responsivity of the sensor is provided in the \"responsivity\" field/object. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which responsivity of the sensor is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which responsivity of the sensor is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which responsivity of the sensor is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which responsivity of the sensor is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity_wl",
"type": "object"
},
"shape": {
"description": "Shape of the photosensitive area of optical sensor included in BRDF measurement set-up as text (i.e. string).",
"title": "shape",
"type": "string"
},
"spectral_response_range": {
"additionalProperties": false,
"description": "An object that specifies wavelength range for sensing of which optical sensor can be applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength that optical sensor can sense as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the shortest wavelength that optical sensor can sense as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the shortest and longest wavelengths that optical sensor can sense as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "spectral_response_range",
"type": "object"
},
"type": {
"description": "Type of the optical sensor used in BRDF measurement set-up as text (i.e. string). For example \"photodiod\", \"CCD-camera\", \"photomultiplyer\" etc.",
"title": "type",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing the ratio of minimum and maximum response signals measured at different points of the detector area in case of fixed wavelength and power. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the uniformity of the optical sensor as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the optical sensor as a positive number from 0 to 1 (or 0 to 100 if in \"%\").",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"name",
"spectral_response_range"
],
"title": "sensor",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and evironment. It also contains a globaly unique dataset identifier, specifices the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"environment": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/environment_json_schema_v1.0.json",
"description": "String or an object with keys describing the environmental conditions during BRDFmeasurement like pressure, temperature, humidity, etc. Object has values as a number or a string.",
"title": "environment",
"type": "object"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in uri format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/instrumentation_json_schema_v1.0.json",
"description": "String or an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. Object has values as a number or a string.",
"title": "instrumentation",
"type": "object"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "Data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"oneOf": [
{
"const": "simulation"
},
{
"const": "measurement"
}
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/provenance_json_schema_v1.0.json",
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sample_json_schema_v1.0.json",
"description": "String or an object with keys describing the virtual or actual sample used to produce BRDF data. Object has values as a number or a string.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL to schema of universal BRDF file format which name also specifies the schema version. As a string in uri format.",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/software_json_schema_v1.0.json",
"description": "String or an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. Object has values as a number or a string.",
"title": "software",
"type": "object"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"name",
"timestamp",
"provenance",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the area of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\", \"m^2\" or \"%\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\" or \"m^2\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the diameter of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the height of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the length of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the radius of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the semi-major axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the semi-minor axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the thickness of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the width of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm2\", \"nm2\", \"\u03bcm2\", \"mm2\", \"dm2\", \"m2\", \"km2\", \"Mm2\" or \"Gm2\".",
"pattern": "^[GMkmd\u03bcnp]?m2$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 88f4fbbe4b6c579418a04dfbf4d92310fe2b7ec6 | "2021-12-12T21:39:54" | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties/fields that allow to describe variables of BRDF function and provide their values alongside BRDF values themselves.",
"properties": {
"BRDF": {
"additionalProperties": false,
"description": "An object describing and providing the bidirectional reflectance distribution function \"BRDF\" values as defined by F. E. Nicodemus. I.e. BRDF values are measured in sr^\u22121 (1/sr) and can vary from 0 sr^\u22121 to inf. sr^\u22121.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"BRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of \"BRDF\" values. It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of \"BRDF\" values as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of \"BRDF\" values as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the \"BRDF\" values. Allowed values are strings \"1/sr\" or \"sr^-1\".",
"enum": [
"1/sr",
"sr^-1"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of measured or simulated \"BRDF\" values corresponding to set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "BRDF",
"type": "object"
},
"adhoc_variables": {
"additionalProperties": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields. It is also advised to place \"adhoc_variable\" object under such \"adhoc_variables\" key that would shortly describe the nature of the user defined variable.",
"title": "adhoc_variable",
"type": "object"
},
"description": "An object containing properties/fields describing user defined BRDF variables. For example, solid angle or illumination/observation spot spatial coordinates if they were varied during BRDF measurements. Most successful variable definitions might become standard definitions and will be included to default parameters of future versions of universal BRDF file format schema.",
"title": "adhoc_variables",
"type": "object"
},
"phi_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence azimuthal angle \"phi_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence azimuthal angle \"phi_i\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to illumination incidence azimuthal angle \"phi_i\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence azimuthal angle \"phi_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence azimuthal angle.",
"description": "The field providing the short description of the \"phi_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_i",
"description": "The field providing the short name of the illumination light incidence azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence azimuthal angle \"phi_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence azimuthal angle \"phi_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_i",
"type": "object"
},
"phi_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation azimuthal angle \"phi_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation azimuthal angle \"phi_r\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to reflected light observation azimuthal angle \"phi_r\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation azimuthal angle \"phi_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation azimuthal angle.",
"description": "The field providing the short description of the \"phi_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_r",
"description": "The field providing the short name of the reflected light observation azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation azimuthal angle \"phi_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation azimuthal angle \"phi_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"index",
"type",
"unit"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_r",
"type": "object"
},
"polarization_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the illumination light polarization state \"polarization_i\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of incidence (https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of incidence is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of incidence and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is illuminated under 0\u00b0 illumination zenith angle \"theta_i\", then it is advised to define plane of incidence using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_i\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light polarization state \"polarization_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light polarization state.",
"description": "The field providing the short description of the \"polarization_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_i",
"description": "The field providing the short name of the illumination light polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe illumination light polarization state \"polarization_i\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light polarization state \"polarization_i\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the illumination light polarization state \"polarization_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_i",
"type": "object"
},
"polarization_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the reflected light observation polarization state \"polarization_r\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of reflectance (i.e. plane defined by the direction of reflectance observation and measurement sample's normal similarly to the plane of incidence - https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of reflectance is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of reflectance and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is observed under 0\u00b0 reflectance observation zenith angle \"theta_r\", then it is advised to define plane of reflectance using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_r\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation polarization state \"polarization_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light observation polarization state.",
"description": "The field providing the short description of the \"polarization_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_r",
"description": "The field providing the short name of the reflected light observation polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe reflected light observation polarization state \"polarization_r\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation polarization state \"polarization_r\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"values",
"units"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the reflected light observation polarization state \"polarization_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_r",
"type": "object"
},
"theta_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence zenith angle \"theta_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence zenith angle \"theta_i\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence zenith angle \"theta_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence zenith angle.",
"description": "The field providing the short description of the \"theta_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_i",
"description": "The field providing the short name of the illumination light incidence zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence zenith angle \"theta_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence zenith angle \"theta_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to \u03c0/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_i",
"type": "object"
},
"theta_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation zenith angle \"theta_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation zenith angle \"theta_r\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation zenith angle \"theta_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation zenith angle.",
"description": "The field providing the short description of the \"theta_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_r",
"description": "The field providing the short name of the reflected light observation zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation zenith angle \"theta_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation zenith angle \"theta_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to 2/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_r",
"type": "object"
},
"uBRDF": {
"additionalProperties": false,
"description": "An object that describes the variable corresponding to non-constant uncertainty of bidirectional reflectance distribution function values \"uBRDF\". I.e. BRDF associated uncertainty that varies with BRDF function parameters/variables. It is a complex quantity that might be affected by the uncertainties of all the variables used for BRDF estimation and most probably is unique for different measurement instruments and simulation models. BRDF uncertainty should be presented in sr^-1 (1/sr) if it is absolute or in % if relative.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to uncertainty of the bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Uncertainty of bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"uBRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the uncertainty of bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"unit": {
"description": "The field that allows to specify measurement unit uncertainty of bidirectional reflectance distribution function values \"uBRDF\" as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the measured or simulated \"BRDF\" uncertainty estimated for each set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "uBRDF",
"type": "object"
},
"wavelength_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light wavelength \"wavelength_i\" and provide its values. This parameter is relevant for spectral BRDF measurements where monochromatic illumination is used and its wavelength is set before the light hits the sample. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light wavelength \"wavelength_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light wavelength.",
"description": "The field providing the short description of the \"wavelength_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_i",
"description": "The field providing the short name of the illumination light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light wavelength \"wavelength_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light wavelength \"wavelength_i\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light wavelength \"wavelength_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_i",
"type": "object"
},
"wavelength_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the observed reflected light wavelength \"wavelength_r\" and provide its values. This parameter is relevant for spectral BRDF measurements where light reflected from the sample is spectrally resolved prior its detection by the sensor. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to the observed reflected light wavelength \"wavelength_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Observed reflected light wavelength.",
"description": "The field providing the short description of the \"wavelength_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_r",
"description": "The field providing the short name of the observed reflected light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the observed reflected light wavelength \"wavelength_r\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the observed reflected light wavelength \"wavelength_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_r",
"type": "object"
}
},
"required": [
"theta_i",
"phi_i",
"theta_r",
"phi_r",
"BRDF"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 47122b0f2e977f136d9ef5ff5878f58c53a68be1 | "2021-12-12T21:40:40" | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties/fields that allow to describe variables of BRDF function and provide their values alongside BRDF values themselves.",
"properties": {
"BRDF": {
"additionalProperties": false,
"description": "An object describing and providing the bidirectional reflectance distribution function \"BRDF\" values as defined by F. E. Nicodemus. I.e. BRDF values are measured in sr^\u22121 (1/sr) and can vary from 0 sr^\u22121 to inf. sr^\u22121.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"BRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of \"BRDF\" values. It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of \"BRDF\" values as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of \"BRDF\" values as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the \"BRDF\" values. Allowed values are strings \"1/sr\" or \"sr^-1\".",
"enum": [
"1/sr",
"sr^-1"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of measured or simulated \"BRDF\" values corresponding to set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "BRDF",
"type": "object"
},
"adhoc_variables": {
"additionalProperties": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields. It is also advised to place \"adhoc_variable\" object under such \"adhoc_variables\" key that would shortly describe the nature of the user defined variable.",
"title": "adhoc_variable",
"type": "object"
},
"description": "An object containing properties/fields describing user defined BRDF variables. For example, solid angle or illumination/observation spot spatial coordinates if they were varied during BRDF measurements. Most successful variable definitions might become standard definitions and will be included to default parameters of future versions of universal BRDF file format schema.",
"title": "adhoc_variables",
"type": "object"
},
"phi_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence azimuthal angle \"phi_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence azimuthal angle \"phi_i\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to illumination incidence azimuthal angle \"phi_i\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence azimuthal angle \"phi_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence azimuthal angle.",
"description": "The field providing the short description of the \"phi_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_i",
"description": "The field providing the short name of the illumination light incidence azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence azimuthal angle \"phi_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence azimuthal angle \"phi_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_i",
"type": "object"
},
"phi_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation azimuthal angle \"phi_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation azimuthal angle \"phi_r\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to reflected light observation azimuthal angle \"phi_r\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation azimuthal angle \"phi_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation azimuthal angle.",
"description": "The field providing the short description of the \"phi_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_r",
"description": "The field providing the short name of the reflected light observation azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation azimuthal angle \"phi_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation azimuthal angle \"phi_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"index",
"type",
"unit"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_r",
"type": "object"
},
"polarization_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the illumination light polarization state \"polarization_i\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of incidence (https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of incidence is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of incidence and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is illuminated under 0\u00b0 illumination zenith angle \"theta_i\", then it is advised to define plane of incidence using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_i\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light polarization state \"polarization_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light polarization state.",
"description": "The field providing the short description of the \"polarization_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_i",
"description": "The field providing the short name of the illumination light polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe illumination light polarization state \"polarization_i\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light polarization state \"polarization_i\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the illumination light polarization state \"polarization_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_i",
"type": "object"
},
"polarization_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the reflected light observation polarization state \"polarization_r\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of reflectance (i.e. plane defined by the direction of reflectance observation and measurement sample's normal similarly to the plane of incidence - https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of reflectance is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of reflectance and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is observed under 0\u00b0 reflectance observation zenith angle \"theta_r\", then it is advised to define plane of reflectance using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_r\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation polarization state \"polarization_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light observation polarization state.",
"description": "The field providing the short description of the \"polarization_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_r",
"description": "The field providing the short name of the reflected light observation polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe reflected light observation polarization state \"polarization_r\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation polarization state \"polarization_r\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"values",
"units"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the reflected light observation polarization state \"polarization_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_r",
"type": "object"
},
"theta_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence zenith angle \"theta_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence zenith angle \"theta_i\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence zenith angle \"theta_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence zenith angle.",
"description": "The field providing the short description of the \"theta_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_i",
"description": "The field providing the short name of the illumination light incidence zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence zenith angle \"theta_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence zenith angle \"theta_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to \u03c0/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_i",
"type": "object"
},
"theta_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation zenith angle \"theta_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation zenith angle \"theta_r\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation zenith angle \"theta_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation zenith angle.",
"description": "The field providing the short description of the \"theta_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_r",
"description": "The field providing the short name of the reflected light observation zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation zenith angle \"theta_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation zenith angle \"theta_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to \u03c0/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_r",
"type": "object"
},
"uBRDF": {
"additionalProperties": false,
"description": "An object that describes the variable corresponding to non-constant uncertainty of bidirectional reflectance distribution function values \"uBRDF\". I.e. BRDF associated uncertainty that varies with BRDF function parameters/variables. It is a complex quantity that might be affected by the uncertainties of all the variables used for BRDF estimation and most probably is unique for different measurement instruments and simulation models. BRDF uncertainty should be presented in sr^-1 (1/sr) if it is absolute or in % if relative.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to uncertainty of the bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Uncertainty of bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"uBRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the uncertainty of bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"unit": {
"description": "The field that allows to specify measurement unit uncertainty of bidirectional reflectance distribution function values \"uBRDF\" as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the measured or simulated \"BRDF\" uncertainty estimated for each set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "uBRDF",
"type": "object"
},
"wavelength_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light wavelength \"wavelength_i\" and provide its values. This parameter is relevant for spectral BRDF measurements where monochromatic illumination is used and its wavelength is set before the light hits the sample. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light wavelength \"wavelength_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light wavelength.",
"description": "The field providing the short description of the \"wavelength_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_i",
"description": "The field providing the short name of the illumination light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light wavelength \"wavelength_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light wavelength \"wavelength_i\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light wavelength \"wavelength_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_i",
"type": "object"
},
"wavelength_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the observed reflected light wavelength \"wavelength_r\" and provide its values. This parameter is relevant for spectral BRDF measurements where light reflected from the sample is spectrally resolved prior its detection by the sensor. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to the observed reflected light wavelength \"wavelength_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Observed reflected light wavelength.",
"description": "The field providing the short description of the \"wavelength_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_r",
"description": "The field providing the short name of the observed reflected light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the observed reflected light wavelength \"wavelength_r\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the observed reflected light wavelength \"wavelength_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_r",
"type": "object"
}
},
"required": [
"theta_i",
"phi_i",
"theta_r",
"phi_r",
"BRDF"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/environment_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the environmental conditions during BRDF measurements that cannot be presented within \"environment\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding environmental conditions during BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding environmental conditions during BRDF measurements. Array of string URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"pressure": {
"additionalProperties": false,
"description": "An object describing pressure within the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\" and \"psi\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "pressure",
"type": "object"
},
"relative_humidity": {
"additionalProperties": false,
"description": "An object describing relative humidity of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "relative_humidity",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing ambient temperature of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the ambient temperature of the environment in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "temperature",
"type": "object"
}
},
"required": [
"temperature"
],
"title": "environment",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/sample_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the physical or virtual sample which BRDF was measured or simulated.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"back_surface_curvature": {},
"back_surface_finish": {},
"back_surface_roughness": {},
"cleaning_procedure": {},
"comments": {
"description": "",
"title": "name",
"type": "string"
},
"data_links": {
"description": "",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {},
"front_surface_curvature": {},
"front_surface_finish": {},
"front_surface_roughness": {},
"manufacturer": {
"description": "",
"title": "name",
"type": "string"
},
"manufacturing_method": {},
"materials": {
"description": "An array with objects that describes different materials from which measurement sample was made.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"name": "material",
"type": "object"
},
"name": "materials",
"type": "array"
},
"model": {},
"name": {
"description": "",
"title": "name",
"type": "string"
},
"origin_location": {},
"photo_links": {},
"properties_symmetry": {},
"provenance": {},
"shape": {},
"specular_reflectance": {},
"specular_transmittance": {},
"temperature": {},
"total_reflectance": {},
"total_transmittance": {},
"treatment": {},
"type": {
"description": "",
"title": "name",
"type": "string"
},
"zero_azimuth_location": {}
},
"required": [
"name",
"type",
"dimensions",
"shape",
"zero_azimuth_location"
],
"title": "sample"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/license_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/license_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"properties": {
"email": {
"description": "E-mail of the natural or legal person who holds full rights for the presented data. String according to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"link": {
"description": "Link to the licence text applicable license as url string.",
"format": "uri",
"title": "link",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of the natural or legal person who holds full rights for the presented data according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"proprietary": {
"description": "Text/string field allowing to provide text of the specific license or comments and additions to existing license template.",
"title": "proprietary",
"type": "string"
},
"rights_holder": {
"description": "Name of the natural or legal person who holds full rights for the presented data. As a string.",
"title": "rights_holder",
"type": "string"
},
"type": {
"description": "Field specifying license agreement applied to the presented datasets. This can be abbreviation according to \"Creative Commons\" license or short name of any other license. Information should be recorded as a string. Note that custom license text can be provided in \"proprietary\" field.",
"title": "type",
"type": "string"
}
},
"required": [
"type",
"rights_holder"
],
"title": "license",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/aperture_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties of the aperture that is a part of the instrument used for BRDF measurement.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the aperture that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding aperture as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding aperture used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the aperture depending on its shape.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the aperture as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material from which aperture was produced as a text (i.e. string).",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the aperture given by manufacturr as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the aperture in a free form as a text (i.e. string).",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the aperture used for BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"type": {
"description": "Type of aperture used for BRDF measurement. For example, \"slit\", \"iris\", \"diaphragm\" etc. A a a text (i.e. string)",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"shape",
"dimensions"
],
"title": "aperture",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/sample_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sample_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "String or an object with keys describing the virtual or actual sample used to produce BRDF data. Object has values as a number or a string.",
"oneOf": [
{
"type": "string"
},
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "object"
}
],
"title": "sample"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/detection_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the detection system used for BRDF measurements that cannot be presented within \"detection_system\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding detection system used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding detection system used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"distance_from_sample": {
"additionalProperties": false,
"description": "An object describing detection system's distance from the sample surface. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of detection system's distance from the sample surface as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's distance from the sample surface as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "distance_from_sample",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of the detector used for BRDF measurements. Array contains unique \"polarization_alterant\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to detect light scattered from the sample with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array",
"uniqueItems": true
},
"sensors": {
"description": "An array of unique objects describing optical sensors of detection system of the instrument used for BRDF measurements. Array contains unique \"sensor\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"title": "sensor",
"type": "object"
},
"title": "sensors",
"type": "array",
"uniqueItems": true
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the detection system's viewing solid angle uncertainty as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the detection system's viewing solid angle uncertainty as a string that can have values \"sr\" or \"%\".",
"enum": [
"sr",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the detection system's viewing solid angle as a string that can have values \"sr\".",
"enum": [
"sr"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's viewing solid angle as a positive number from 0 to 12.57 (i.e. from 0 to 4\u03c0 limits included).",
"maximum": 12.57,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"viewed_area": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"shape\" and \"dimensions\".",
"properties": {
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the area viewed by detection system during BRDF measurements.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"shape": {
"description": "Shape of the area viewed by detection system during BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"title": "viewed_area",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges for detection as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"sensors",
"solid_angle"
],
"title": "detection_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 6d2e51a05be792805dd83c8ea1da84f681c5e7f7 | "2021-11-26T20:32:33" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and evironment. It also contains a globaly unique dataset identifier, specifices the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"environment": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"description": "String or an object with keys describing the environmental conditions during BRDFmeasurement like pressure, temperature, humidity, etc. Object has values as a number or a string.",
"title": "environment",
"type": "object"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in uri format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"description": "String or an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. Object has values as a number or a string.",
"title": "instrumentation",
"type": "object"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "Data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"oneOf": [
{
"const": "simulation"
},
{
"const": "measurement"
}
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"description": "String or an object with keys describing the virtual or actual sample used to produce BRDF data. Object has values as a number or a string.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL to schema of universal BRDF file format which name also specifies the schema version. As a string in uri format.",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"description": "String or an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. Object has values as a number or a string.",
"title": "software",
"type": "object"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"name",
"timestamp",
"provenance",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | "2021-11-26T18:53:57" | BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/simulation_model_parameter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"model_parameter\" object) describing any information relevant to the single mathematical or physical simulation model parameter. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the described mathematical or physical simulation model parameter used within it to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the mathematical or physical simulation model parameter that were used to produce BRDF data presented in the file. For example, link to the source of numerical value of the described model parameter.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the meaning of the mathematical or physical simulation model parameter as a text (i.e. string).",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the mathematical or physical simulation model parameter as a string.",
"title": "name",
"type": "string"
},
"symbol": {
"description": "Symbol used in equation to denote the mathematical or physical simulation model parameter as a string.",
"title": "symbol",
"type": "string"
},
"unit": {
"description": "Unit of the value of mathematical or physical simulation model parameter as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the mathematical or physical simulation model parameter as a number. Value should represent the exact same value of the parameter that was used to produce BRDF data presented in the file.",
"title": "value",
"type": "number"
}
},
"required": [
"name",
"description",
"value",
"unit"
],
"title": "model_parameter"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the area of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\", \"m^2\" or \"%\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\" or \"m^2\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the diameter of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the height of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the length of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the radius of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the semi-major axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the semi-minor axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the thickness of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the width of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/environment_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the environmental conditions during BRDF measurements that cannot be presented within \"environment\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding environmental conditions during BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding environmental conditions during BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"pressure": {
"additionalProperties": false,
"description": "An object describing pressure within the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\", \"psi\" or \"%\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\" and \"psi\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "pressure",
"type": "object"
},
"relative_humidity": {
"additionalProperties": false,
"description": "An object describing relative humidity of the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "relative_humidity",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing ambient temperature of the environment in which measurement sample's BRDF was measured. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the ambient temperature of the environment in which measurement sample's BRDF was measured as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the ambient temperature of the environment in which measurement sample's BRDF was measured as a number that can have positive and negative values. In allowed units the minimum allowed value is \u2212273.15 (\u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "temperature",
"type": "object"
}
},
"required": [
"temperature"
],
"title": "environment",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | cb87a85e1b3b5c96f8eb446c6689ad0bf614a34a | "2021-11-26T23:15:13" | BRDF_JSON_schema/sample_material_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the specific material from which measurement sample was produced (either partially or fully) that cannot be presented within sample \"material\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"chemical_formula": {
"description": "Chemical formula of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "chemical_formula",
"type": "string"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to the specific material from which measurement sample was produced (either partially or fully).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array with links to any relevant information regarding specific material from which measurement sample was produced (either partially or fully). For example regarding the origin of refractive index and extinction coefficient or relevant transmission, absorption or fluorescence spectra.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"extinction_coefficient": {
"additionalProperties": false,
"description": "An object describing extinction coefficient (or absorption index k) of the material from rom which measurement sample was produced (either partially or fully). It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "By definition extinction coefficient (or absorption index k) is unitless, but to maintain single pattern for all numerical properties, unit is also demanded here even thou it can only have empty string value \"\".",
"enum": [
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the extinction coefficient (or absorption index k) of the material as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient",
"type": "object"
},
"extinction_coefficient_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which extinction coefficient (or absorption index k) of the material is provided in the field \"extinction_coefficient\". It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient_wl",
"type": "object"
},
"layer_number": {
"description": "An integer number that describes the position of the material in the sample structure in case of layered sample composition. Numbering starts from the top surface i.e. from the material that is hit with the illumination first during sample's BRDF measurement. Numbering starts from 1.",
"title": "layer_number",
"type": "integer"
},
"name": {
"description": "Naming of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "name",
"type": "string"
},
"refractive_index": {
"additionalProperties": false,
"description": "An object describing refractive index (n) of the material from rom which measurement sample was produced (either partially or fully). It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "By definition refractive index (n) is unitless, but to maintain single pattern for all numerical properties, unit is also demanded here even thou it can only have empty string value \"\".",
"enum": [
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the refractive index (n) of the material as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "refractive_index",
"type": "object"
},
"refractive_index_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which refractive index (n) of the material is provided in the field \"refractive_index\". It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the wavelength for which refractive index (n) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which refractive index (n) of the material is provided as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "refractive_index_wl",
"type": "object"
},
"type": {
"description": "Short description of the material's structural role as a string. For example \"main material\", \"substrate\", \"coating\".",
"title": "type",
"type": "string"
}
},
"required": [
"name"
],
"title": "material"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/optical_filter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "The \"optical_filter\" object describes properties of a single optical filter that was used during BRDF measurements. Note that the same object describes optical filters integrated to illumination or detection systems.",
"oneOf": [
{
"required": [
"name",
"type",
"cut_on_wl"
]
},
{
"required": [
"name",
"type",
"cut_off_wl"
]
},
{
"required": [
"name",
"type",
"wl_range"
]
},
{
"required": [
"name",
"type",
"central_wl",
"transmission_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical filter placed in in the path of light of illumination source that cannot be presented within \"filter\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"avg_transmittance": {
"additionalProperties": false,
"description": "Average transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "avg_transmittance",
"type": "object"
},
"blocking_avg": {
"additionalProperties": false,
"description": "Average blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "blocking_avg",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "The central transmission wavelength of the of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter central transmission wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter central transmission wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter central transmission wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter central transmission wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"comments": {
"description": "An object that allows to provide any additional information regarding used for BRDF measurements as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"cut_off_wl": {
"additionalProperties": false,
"description": "A cut-off wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-off wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-off wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-off wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-off wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_off_wl",
"type": "object"
},
"cut_on_wl": {
"additionalProperties": false,
"description": "A cut-on wavelength of an optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter cut-on wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter cut-on wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter cut-on wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-on wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_on_wl",
"type": "object"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical filter is designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the the uncertainty of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical filter is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding optical filter used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "material",
"type": "string"
},
"max_blocking": {
"additionalProperties": false,
"description": "Maximal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_blocking"
},
"max_transmittance": {
"additionalProperties": false,
"description": "Maximal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's maximal transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's maximal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_transmittance",
"type": "object"
},
"min_blocking": {
"additionalProperties": false,
"description": "Minimal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density) or \"%\".",
"enum": [
"OD",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density).",
"enum": [
"OD"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal blocking/absorption value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_blocking"
},
"min_transmittance": {
"additionalProperties": false,
"description": "Minimal transmittance value of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's minimal transmittance value as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical filter's minimal transmittance value as a string that can have values \"%\" or \"\" i.e. unitless.",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal transmittance value as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_transmittance",
"type": "object"
},
"model": {
"description": "Model of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "name",
"type": "string"
},
"transmittance_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of the spectral transmission range of the optical filter used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical filter's transmission FWHM as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Unit of the uncertainty of the optical filter's transmission FWHM as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Unit of the optical filter's transmission FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's transmission FWHM as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmittance_FWHM",
"type": "object"
},
"type": {
"description": "Type of an optical filter used for BRDF measurements. For example, \"interference filter\", \"neutral density filter\", \"absorptive filter\" etc. as a text (i.e.string).",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "The field describing transmission wavelength range of the optical filter used for BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the optical filter's transmission longest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the optical filter's transmission shortest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the optical filter's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "optical_filter",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/detection_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the detection system used for BRDF measurements that cannot be presented within \"detection_system\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding detection system used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding detection system used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"distance_from_sample": {
"additionalProperties": false,
"description": "An object describing detection system's distance from the sample surface. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's distance from the sample surface as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "distance_from_sample",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of the detector used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to detect light scattered from the sample with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array"
},
"sensors": {
"description": "An array of objects describing optical sensors of detection system of the instrument used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"title": "sensor",
"type": "object"
},
"title": "sensors",
"type": "array"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the detection system's viewing solid angle as a string that can have values \"sr\".",
"pattern": "sr",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's viewing solid angle as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"viewed_area": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"shape\" and \"dimensions\".",
"properties": {
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the area viewed by detection system during BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"shape": {
"description": "Shape of the area viewed by detection system during BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"title": "viewed_area",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges for detection as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"sensor",
"solid_angle"
],
"title": "detection_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing optical components that were used to select/filter specific wavelength or wavelength ranges from incoming radiation as well as properties and settings these components.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the wavelength selecting optical elements and devices that cannot be presented within \"wavelength_selectors\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A field for providing any additional information regarding wavelength selecting optical elements and devices as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"monochromator": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_json_schema_v1.0.json",
"description": "The object describing properties and settings of the monochromator used for BRDF measurements.",
"title": "monochromator",
"type": "object"
},
"optical_filters": {
"description": "An array of \"optical_filter\" objects each describing the filters that were used to define illumination or collected light spectral properties during BRDF measurement.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"description": "The \"optical_filter\" object describing properties of the optical filter used for BRDF measurement.",
"title": "optical_filter",
"type": "object"
},
"title": "optical_filters",
"type": "array"
}
},
"required": [],
"title": "wavelength_selectors",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/reference_info_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object briefly describing reference sample and related reference BRDF data used for relative BRDF measurements. Full description of reference sample/data can be provided as a link to external data in \"data_links\" object.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"reference_info\" object) describing any information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to any available external information reference sample or reference BRDF data used for relative BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the reference sample used for relative BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the reference sample used for relative BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Short description of the material from which reference sample used for relative BRDF measurements was made as text (i.e. string). For example \"BaSO4\", \"PTFE\", \"ceramic\" etc. Full description of reference sample can be provided as a link external data in \"data_links\" object.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the reference sample that was used for the relative BRDF measurements of data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the reference sample that was used for the relative BRDF measurements of data presented within the file.",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the reference sample used for relative BRDF measurements as text (i.e. string). ",
"title": "shape",
"type": "string"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing solid angle that was used for reference BRDF data acquisition. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the solid angle that was used for reference BRDF data acquisition as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the solid angle that was used for reference BRDF data acquisition as a string that can have values \"sr\" and \"%\".",
"enum": [
"sr",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the solid angle that was used for reference BRDF data acquisition as a string that can have value \"sr\".",
"enum": [
"sr"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the solid angle that was used for reference BRDF data acquisition as a positive number from 0 to 12.57 (i.e. from 0 to 4\u03c0 limits included). Shortly: 0 \u2264 x \u2264 12.57",
"maximum": 12.57,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angle",
"type": "object"
},
"type": {
"description": "Type of the reference sample used for relative BRDF measurements as text (i.e. string). For example \"white diffuse reflectance standard\", \"colored diffuse reflectance standard\", \"grey diffuse reflectance standard\" etc.",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"solid_angle"
],
"title": "reference_info",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/source_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/source_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes illumination source that was used for BRDF measurements.",
"oneOf": [
{
"required": [
"name",
"type",
"power",
"wl_range"
]
},
{
"required": [
"name",
"type",
"power",
"central_wl"
]
}
],
"properties": {
"CIE_notation": {
"description": "Field that allows to classify light source according to CIE abbreviations for standard illuminants. It accommodates text (i.e.string) values corresponding only to CIE abbreviations. For information about values see https://en.wikipedia.org/wiki/Standard_illuminant.",
"enum": [
"A",
"B",
"C",
"D50",
"D55",
"D65",
"D75",
"D93",
"E",
"F1",
"F2",
"F3",
"F4",
"F5",
"F6",
"F7",
"F8",
"F9",
"F10",
"F11",
"F12",
"LED-B1",
"LED-B2",
"LED-B3",
"LED-B4",
"LED-B5",
"LED-B1",
"LED-BH1",
"LED-RGB1",
"LED-V2"
],
"title": "CIE_notation",
"type": "string"
},
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination source of the instrument that cannot be presented within \"source\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "Property describing the central wavelength of illumination light source. It is most relevant for lasers and narrow-band LEDs. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source central wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source central wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source central wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"color_temperature": {
"additionalProperties": false,
"description": "The field allowing to specify color temperature of black-body radiator if it was used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source color temperature as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source color temperature as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source color temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source color temperature as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "color_temperature",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding illumination source that was used for BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding light source used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "The property that allows to specify the manufacturer of the light source that used for BRDF measurements. For example, company or workshop name written as a text (i.e.string)",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "The property that allows to specify the model of the illumination source that was used for BRDF measurements. It can be written as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the light source that was used for BRDF measurements. Can be written in a free form as a text (string).",
"title": "name",
"type": "string"
},
"operating_current": {
"additionalProperties": false,
"description": "An object describing the current at which illumination source was operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating current as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"%\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\" or \"GA\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating current as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_current",
"type": "object"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light source was operated. Might be relevant in case of cooled light sources or lasers/LEDs which central wavelength can change with temperature. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating temperature as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating temperature as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating temperature as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"operating_voltage": {
"additionalProperties": false,
"description": "An object describing the voltage at which illumination source was operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating voltage as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\" or \"%\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating voltage as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_voltage",
"type": "object"
},
"power": {
"additionalProperties": false,
"description": "The property describing integral power of the illumination source in power units like W, kW, mW etc. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source power as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source power as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "power",
"type": "object"
},
"type": {
"description": "The field that specifies what type of illumination source was used for BRDF measurements. For example it can be laser, incandescent lamp, black-body, LED etc. String values are allowed.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "An object allowing to specify the wavelength range within which illumination source radiates. Most relevant for wide-band sources as incandescent lamps, fluorescent lamps, black-bodies etc. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the illumination source longest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the illumination source shortest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the illumination source shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"title": "source",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/beam_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/beam_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination beam that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding illumination beam as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination beam used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the beam at the surface of the measurement sample.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"divergence": {
"additionalProperties": false,
"description": "An object describing divergence of the illumination beam that hits the surface of the measurement sample. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination beam divergence as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination beam divergence as a string that can have values \"deg\", \"\u00b0\", \"rad\" or \"%\".",
"enum": [
"deg",
"\u00b0",
"rad",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the divergence of the illumination beam that hits the surface of the measurement sample as a string that can have values \"deg\", \"\u00b0\", \"rad\".",
"enum": [
"deg",
"\u00b0",
"rad"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the divergence of the illumination beam that hits the surface of the measurement sample as a positive number from 0 to 360 degrees (or 0 to 2\u03c0 radians).",
"maximum": 360,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "divergence",
"type": "object"
},
"shape": {
"description": "Shape of the illumination beam at the surface of the measurement sample as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing uniformity of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of illumination beam uniformity at the surface of the measurement sample as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of illumination beam uniformity at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"%",
""
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the uniformity of the illumination beam at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"%",
""
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the illumination beam at the surface of the measurement sample as a positive number from 0 to 100.",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"shape",
"dimensions"
],
"title": "beam",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/monochromator_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties and set parameters of the monochromator included to the set-up used for (usually spectral) BRDF measurements. Note that the same object describes monochromators integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator used for illumination or detection light wavelength selection during BRDF measurements that cannot be presented within \"monochromator\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section for providing any relevant information regarding monochromator used during BRDF measurements as a string/text.",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field for indication of maximum optical power at which monochromator was designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximum optical power at which monochromator was designed to be operated without damage as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum optical power at which monochromator was designed to be operated without damage as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold",
"type": "object"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding monochromator used during BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the monochromator used for BRDF measurements. As a text (i.e.string).",
"title": "name",
"type": "string"
},
"settings": {
"description": "An array with unique objects that describe monochromator settings for a single selected wavelength or different wavelength ranges that were used for BRDF measurements. Array contains unique \"monochromator_setting\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"title": "monochromator_setting",
"type": "object"
},
"title": "settings",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "Type of the monochromator used to select illumination or detection wavelength during BRDF measurements. For example \"prism based monochromatror\", \"double monochromator\" etc. As a text (i.e.string).",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"settings"
],
"title": "monochromator",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"oneOf": [
{
"required": [
"wl_range",
"bandpass_FWHM"
]
},
{
"required": [
"selected_wl",
"bandpass_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator parameters used during BRDF measurements that cannot be presented within \"monochromator_setting\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section"
},
"bandpass_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of spectral band passed through monochromator. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's bandpass FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's bandpass FWHM as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bandpass_FWHM",
"type": "object"
},
"comments": {
"description": "A field allowing to describe any additional information related to monochromator settings as a text (i.e. string)",
"title": "comments",
"type": "string"
},
"selected_wl": {
"additionalProperties": false,
"description": "Wavelength that was selected at monochromator settings for single-wavelength BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the set monochromator's wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the set monochromator's wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"slit_width": {
"additionalProperties": false,
"description": "Slit width of the monochromator for the given wavelength range. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\" or \"m\".",
"pattern": "^[\u03bcnm]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's slit width as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "slit_width",
"type": "object"
},
"spectral_resolution": {
"additionalProperties": false,
"description": "Description of monochromator's wavelength resolving/separation/dispersion capabilities as width of transmitted light spectral band per width of monochromator output slit. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\".",
"pattern": "nm/mm$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's wavelength resolving/separation/dispersion capabilities as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "spectral_resolution",
"type": "object"
},
"wl_range": {
"additionalProperties": false,
"description": "Design or set operation wavelength range of the monochromator used to select illumination or detection wavelength during BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the monochromator's transmission longest wavelength as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the monochromator's transmission shortest wavelength as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the monochromator's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "monochromator_setting",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/reference_info_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing reference sample and related reference BRDF data used for relative BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"reference_info\" object) describing any information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to any available external information reference sample or reference BRDF data used for relative BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the reference sample used for relative BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the reference sample used for relative BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material from which reference sample used for relative BRDF measurements was made as text (i.e. string). For example \"BaSO4\", \"PTFE\", \"ceramic\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the reference sample that was used for the relative BRDF measurements of data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the reference sample that was used for the relative BRDF measurements of data presented within the file.",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the reference sample used for relative BRDF measurements as text (i.e. string). ",
"title": "shape",
"type": "string"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing solid angle that was used for reference BRDF data acquisition. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the solid angle that was used for reference BRDF data acquisition as a string that can have values \"sr\".",
"pattern": "sr",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the solid angle that was used for reference BRDF data acquisition as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"type": {
"description": "Type of the reference sample used for relative BRDF measurements as text (i.e. string). For example \"white diffuse reflectance standard\", \"colored diffuse reflectance standard\", \"grey diffuse reflectance standard\" etc.",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"solid_angle"
],
"title": "reference_info",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/monochromator_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties and set parameters of the monochromator included to the set-up used for (usually spectral) BRDF measurements. Note that the same object describes monochromators integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator used for illumination or detection light wavelength selection during BRDF measurements that cannot be presented within \"monochromator\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section for providing any relevant information regarding monochromator used during BRDF measurements as a string/text.",
"title": "comments",
"type": "string"
},
"damage_treshold": {
"additionalProperties": false,
"description": "Field for indication of maximum optical power at which monochromator was designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum optical power at which monochromator was designed to be operated without damage as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold",
"type": "object"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding monochromator used during BRDF measurements. Array of text (i.e.string) URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the monochromator used for BRDF measurements. As a text (i.e.string).",
"title": "name",
"type": "string"
},
"settings": {
"description": "And array with objects that describes monochromator settings for a single selected wavelength or different wavelength ranges that were used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"title": "monochromator_setting",
"type": "object"
},
"title": "settings",
"type": "array"
},
"type": {
"description": "Type of the monochromator used to select illumination or detection wavelength during BRDF measurements. For example \"prism based monochromatror\", \"double monochromator\" etc. As a text (i.e.string).",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"settings"
],
"title": "monochromator",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/provenance_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"properties": {
"comments": {
"description": "Any additional iformation related to the provenance of the presented data in text form.",
"title": "comments",
"type": "string"
},
"contact_person": {
"description": "Name of the contact person representing the organization.",
"title": "contact_person",
"type": "string"
},
"email": {
"description": "Contact email of organization or its contact person. According to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"location": {
"additionalProperties": false,
"description": "Object that specifies physical location or address of organization that provided dataset recorded within the file.",
"properties": {
"building_nr": {
"description": "Street number of the building where organization is residing",
"title": "organization",
"type": "string"
},
"city": {
"description": "Name of the city where organization is located",
"title": "organization",
"type": "string"
},
"coordinates": {
"description": "Organization location coordinates according to ISO 6709 standard",
"title": "organization",
"type": "string"
},
"country": {
"description": "Name of the country where organization is located",
"title": "organization",
"type": "string"
},
"county": {
"description": "Name of the county within country where organization is located",
"title": "organization",
"type": "string"
},
"postal_code": {
"description": "Postal code of organization's address.",
"title": "organization",
"type": "string"
},
"room_nr": {
"description": "Laboratory or the room number within the organization's building",
"title": "organization",
"type": "string"
},
"street": {
"description": "Name of the street within city where organization is located",
"title": "organization",
"type": "string"
}
},
"required": [
"country",
"city",
"street",
"building_nr",
"postal_code"
],
"title": "location",
"type": "object"
},
"organization": {
"description": "Name of the company, organization, institution, university etc. that produced the dataset recorded within the file.",
"title": "organization",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of organization or its contact person according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"website": {
"description": "URL of the organization/institution's web-page if available.",
"format": "uri",
"title": "website",
"type": "string"
}
},
"required": [
"organization",
"location",
"email",
"contact_person"
],
"title": "provenance",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/reference_info_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/reference_info_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object briefly describing reference sample and related reference BRDF data used for relative BRDF measurements. Full description of reference sample/data can be provided as a link to external data in \"data_links\" object.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"reference_info\" object) describing any information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to any available external information reference sample or reference BRDF data used for relative BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the reference sample used for relative BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the reference sample used for relative BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Short description of the material from which reference sample used for relative BRDF measurements was made as text (i.e. string). For example \"BaSO4\", \"PTFE\", \"ceramic\" etc. Full description of reference sample can be provided as a link external data in \"data_links\" object.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the reference sample that was used for the relative BRDF measurements of data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the reference sample that was used for the relative BRDF measurements of data presented within the file.",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the reference sample used for relative BRDF measurements as text (i.e. string). ",
"title": "shape",
"type": "string"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing solid angle that was used for reference BRDF data acquisition. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the solid angle that was used for reference BRDF data acquisition as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the solid angle that was used for reference BRDF data acquisition as a string that can have values \"sr\" and \"%\".",
"enum": [
"sr",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the solid angle that was used for reference BRDF data acquisition as a string that can have value \"sr\".",
"enum": [
"sr"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the solid angle that was used for reference BRDF data acquisition as a positive number from 0 to 12.57 (i.e. from 0 to 4\u03c0 limits included).",
"maximum": 12.57,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angle",
"type": "object"
},
"type": {
"description": "Type of the reference sample used for relative BRDF measurements as text (i.e. string). For example \"white diffuse reflectance standard\", \"colored diffuse reflectance standard\", \"grey diffuse reflectance standard\" etc.",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"solid_angle"
],
"title": "reference_info",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/illumination_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/illumination_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing illumination system, illumination source, relevant optical components and illumination beam properties.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination system of the instrument that cannot be presented within \"illumination\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"beam": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/beam_json_schema_v1.0.json",
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"title": "beam",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding instrument illumination system as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination system used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Field for providing manufacturer of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_manufacturer",
"type": "string"
},
"model": {
"description": "Field for providing model of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_model",
"type": "string"
},
"name": {
"description": "Field for providing name of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of unique objects describing polarization altering elements placed in the path of illumination light used for BRDF measurements. Array contains unique \"polarization_alterant\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to produce illumination with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array",
"uniqueItems": true
},
"source": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/source_json_schema_v1.0.json",
"description": "An object that describes source of the illumination used for BRDF measurements.",
"title": "source",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges from illumination source radiation as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"source",
"beam"
],
"title": "illumination_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/sensor_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sensor_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical sensor used for BRDF measurements that cannot be presented within \"sensor\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bias_voltage": {
"additionalProperties": false,
"description": "An object describing bias voltage applied applied to the optical sensor during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"pattern": "^[pn\u03bcmkMG]?V$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the bias voltage applied applied to the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bias_voltage",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding optical sensor used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical sensor is designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical sensor is designed to be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"dark_signal": {
"additionalProperties": false,
"description": "An object describing the level of signal when sensor is not exposed to any radiation (in Ampers (A) or Volts (V)). It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"oneOf": [
{
"pattern": "^[pn\u03bcmkMG]?A$"
},
{
"pattern": "^[pn\u03bcmkMG]?V$"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's dark current as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "dark_signal",
"type": "object"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding optical sensor used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the photosensitive part of the sensor included in BRDF measurement set-up.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"linearity": {
"additionalProperties": false,
"description": "An object describing the maximal ratio between photosensitivities around different optical powers that sensor can sense in case of fixed detection wavelength. It is defined as min_responsivity / max_responsivity for power range used for BRDF measurements. \"nonlinearity\" object has keys keys \"value\" and \"unit\"",
"properties": {
"unit": {
"description": "Unit of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's linearity as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "linearity",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Light sensing material used in optical sensor included in BRDF measurement set-up as text (i.e. string). For example \"Si\", \"InGaAs\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "name",
"type": "string"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light sensor was operated during BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"oneOf": [
{
"pattern": "^[k]?K$"
},
{
"pattern": "\u00b0C"
}
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature at which light sensor was operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"photosensitivity": {
"additionalProperties": false,
"description": "Typical or average photosensitivity of optical sensor in A/W. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the set typical or average photosensitivity of optical sensor as a string that can have values \"A/W\".",
"pattern": "A/W",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the typical or average photosensitivity of optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "photosensitivity",
"type": "object"
},
"power_range": {
"additionalProperties": false,
"description": "An object describing the optical power range in which optical sensor can be usually applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the highest optical power sensor can detect as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the lowest optical power sensor can detect as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the lowest and highest power that optical sensor can detect as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"pattern": "^[GMkm\u03bcnp]?W$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "power_range",
"type": "object"
},
"shape": {
"description": "Shape of the photosensitive area of optical sensor included in BRDF measurement set-up as text (i.e. string).",
"title": "shape",
"type": "string"
},
"spectral_response_range": {
"additionalProperties": false,
"description": "An object that specifies wavelength range for sensing of which optical sensor can be applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength that optical sensor can sense as a number.",
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the shortest wavelength that optical sensor can sense as a number.",
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Unit of the shortest and longest wavelengths that optical sensor can sense as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "spectral_response_range",
"type": "object"
},
"type": {
"description": "Type of the optical sensor used in BRDF measurement set-up as text (i.e. string). For example \"photodiod\", \"CCD-camera\", \"photomultiplyer\" etc.",
"title": "type",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing the ratio of minimum and maximum response signals measured at different points of the detector area in case of fixed wavelength and power. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the optical sensor as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"name",
"spectral_response_range"
],
"title": "sensor",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/brdf_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/brdf_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A JSON schema for automatic validation of Universal BRDF data format proposed by BiRD project consortium in 2021",
"properties": {
"data": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"description": "An object with keys related to definition of BRDF function, variable properties of BRDF data and BRDF values themselves",
"title": "data",
"type": "object"
},
"metadata": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and environment. It also contains a globally unique dataset identifier, specifies the data type, file name and records a timestamp of a measurement or simulation",
"title": "metadata",
"type": "object"
}
},
"required": [
"metadata",
"data"
],
"title": "Universal BRDF data format schema",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"oneOf": [
{
"required": [
"wl_range",
"bandpass_FWHM"
]
},
{
"required": [
"selected_wl",
"bandpass_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator parameters used during BRDF measurements that cannot be presented within \"monochromator_setting\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bandpass_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of spectral band passed through monochromator. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's bandpass FWHM as a zero (0) inclusive positive number..",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's bandpass FWHM as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's bandpass FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's bandpass FWHM as a zero (0) inclusive positive number..",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bandpass_FWHM",
"type": "object"
},
"central_wl_uncertainty": {
"additionalProperties": false,
"description": "An object describing the average uncertainty of the monochromator's transmitted band central wavelength value within a given wavelength range. It is an object with following available keys: \"value\", \"unit\".",
"properties": {
"unit": {
"description": "Measurement unit of the average uncertainty of the monochromator's transmitted band central wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the average uncertainty of the monochromator's transmitted band central wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"comments": {
"description": "A field allowing to describe any additional information related to monochromator settings as a text (i.e. string)",
"title": "comments",
"type": "string"
},
"selected_dispersive_element": {
"description": "Name and/or type of the selected monochromator's wavelength dispersive element as text (i.e. string). For example, \"diffraction grating designed for visible wavelength region\" or \"volumetric Bragg grating designed for NIR wavelength region\".",
"title": "selected_dispersive_element",
"type": "string"
},
"selected_wl": {
"additionalProperties": false,
"description": "Wavelength that was selected at monochromator settings for single-wavelength BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the set monochromator's wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the set monochromator's wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the set monochromator's wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the set monochromator's wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"slit_width": {
"additionalProperties": false,
"description": "Slit width of the monochromator for the given wavelength range. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's slit width as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\", \"m\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"mm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\" or \"m\".",
"enum": [
"nm",
"\u03bcm",
"mm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's slit width as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "slit_width",
"type": "object"
},
"spectral_resolution": {
"additionalProperties": false,
"description": "Description of monochromator's wavelength resolving/separation/dispersion capabilities as width of transmitted light spectral band per width of monochromator output slit. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's wavelength resolving/separation/dispersion capabilities as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\" or \"%\".",
"enum": [
"nm/mm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\".",
"enum": [
"nm/mm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's wavelength resolving/separation/dispersion capabilities as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "spectral_resolution",
"type": "object"
},
"wl_range": {
"additionalProperties": false,
"description": "Design or set operation wavelength range of the monochromator used to select illumination or detection wavelength during BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the monochromator's transmission longest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the monochromator's transmission shortest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the monochromator's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "monochromator_setting",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/software_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/software_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the software as well as the mathematical/physical simulation model and its parameters used to produce BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"author": {
"description": "",
"title": "name",
"type": "string"
},
"comments": {
"description": "",
"title": "name",
"type": "string"
},
"data_links": {
"description": "",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "",
"title": "name",
"type": "string"
},
"model": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/model_json_schema_v1.0.json",
"description": "",
"title": "name",
"type": "object"
},
"name": {
"description": "",
"title": "name",
"type": "string"
},
"version": {
"description": "",
"title": "name",
"type": "string"
}
},
"required": [
"name"
],
"title": "software"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"model_parameter\" object) describing any information relevant to the single mathematical or physical simulation model parameter. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the described mathematical or physical simulation model parameter used within it to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of unique links as a strings in URL format that allow to refer to any external information related to the mathematical or physical simulation model parameter that were used to produce BRDF data presented in the file. For example, link to the source of numerical value of the described model parameter.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the meaning of the mathematical or physical simulation model parameter as a text (i.e. string).",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the mathematical or physical simulation model parameter as a string.",
"title": "name",
"type": "string"
},
"symbol": {
"description": "Symbol used in equation to denote the mathematical or physical simulation model parameter as a string.",
"title": "symbol",
"type": "string"
},
"uncertainty": {
"description": "Numerical value of the uncertainty of the mathematical or physical simulation model parameter as a number. Value should represent the exact same value of the parameter that was used to produce BRDF data presented in the file.",
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the value of mathematical or physical simulation model parameter as a string.",
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the value of mathematical or physical simulation model parameter as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the mathematical or physical simulation model parameter as a number. Value should represent the exact same value of the parameter that was used to produce BRDF data presented in the file.",
"title": "value",
"type": "number"
}
},
"required": [
"name",
"description",
"value",
"unit"
],
"title": "model_parameter"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"model_parameter\" object) describing any information relevant to the single mathematical or physical simulation model parameter. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the described mathematical or physical simulation model parameter used within it to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the mathematical or physical simulation model parameter that were used to produce BRDF data presented in the file. For example, link to the source of numerical value of the described model parameter.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the meaning of the mathematical or physical simulation model parameter as a text (i.e. string).",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the mathematical or physical simulation model parameter as a string.",
"title": "name",
"type": "string"
},
"symbol": {
"description": "Symbol used in equation to denote the mathematical or physical simulation model parameter as a string.",
"title": "symbol",
"type": "string"
},
"unit": {
"description": "Unit of the value of mathematical or physical simulation model parameter as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the mathematical or physical simulation model parameter as a number. Value should represent the exact same value of the parameter that was used to produce BRDF data presented in the file.",
"title": "value",
"type": "number"
}
},
"required": [
"name",
"description",
"value",
"unit"
],
"title": "model_parameter"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/provenance_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/provenance_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"properties": {
"comments": {
"description": "Any additional iformation related to the provenance of the presented data in text form.",
"title": "comments",
"type": "string"
},
"contact_person": {
"description": "Name of the contact person representing the organization.",
"title": "contact_person",
"type": "string"
},
"email": {
"description": "Contact email of organization or its contact person. According to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"location": {
"additionalProperties": false,
"description": "Object that specifies physical location or address of organization that provided dataset recorded within the file.",
"properties": {
"building_nr": {
"description": "Street number of the building where organization is residing",
"title": "organization",
"type": "string"
},
"city": {
"description": "Name of the city where organization is located",
"title": "organization",
"type": "string"
},
"coordinates": {
"description": "Organization location coordinates according to ISO 6709 standard",
"title": "organization",
"type": "string"
},
"country": {
"description": "Name of the country where organization is located",
"title": "organization",
"type": "string"
},
"county": {
"description": "Name of the county within country where organization is located",
"title": "organization",
"type": "string"
},
"postal_code": {
"description": "Postal code of organization's address.",
"title": "organization",
"type": "string"
},
"room_nr": {
"description": "Laboratory or the room number within the organization's building",
"title": "organization",
"type": "string"
},
"street": {
"description": "Name of the street within city where organization is located",
"title": "organization",
"type": "string"
}
},
"required": [
"country",
"city",
"street",
"building_nr",
"postal_code"
],
"title": "location",
"type": "object"
},
"organization": {
"description": "Name of the company, organization, institution, university etc. that produced the dataset recorded within the file.",
"title": "organization",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of organization or its contact person according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"website": {
"description": "Url of the organization/institution's web-page if available.",
"format": "uri",
"title": "website",
"type": "string"
}
},
"required": [
"organization",
"location",
"email",
"contact_person"
],
"title": "provenance",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | c7a28461d80a0d6d2b999aef10368ab2036ea858 | "2021-11-26T23:57:35" | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm^2\", \"nm^2\", \"\u03bcm^2\", \"mm^2\", \"dm^2\" or \"m^2\".",
"enum": [
"pm^2",
"nm^2",
"\u03bcm^2",
"mm^2",
"dm^2",
"m^2"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/detection_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/detection_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the detection system used for BRDF measurements that cannot be presented within \"detection_system\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding detection system used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding detection system used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"distance_from_sample": {
"additionalProperties": false,
"description": "An object describing detection system's distance from the sample surface. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's distance from the sample surface as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "distance_from_sample",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of the detector used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to detect light scattered from the sample with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array"
},
"sensors": {
"description": "An array of objects describing optical sensors of detection system of the instrument used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sensor_json_schema_v1.0.json",
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"title": "sensor",
"type": "object"
},
"title": "sensors",
"type": "array"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the detection system's viewing solid angle as a string that can have values \"sr\".",
"pattern": "sr",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's viewing solid angle as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"viewed_area": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"shape\" and \"dimensions\".",
"properties": {
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the area viewed by detection system during BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"shape": {
"description": "Shape of the area viewed by detection system during BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"title": "viewed_area",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges for detection as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"sensor",
"solid_angle"
],
"title": "detection_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | abb260b11e5b26a1a83b37af41d6766651900e14 | "2021-12-06T00:02:04" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and environment. It also contains a globally unique dataset identifier, specifies the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding BRDF data presented within the file. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A short description in the form of text (i.e. string) of the the measured or simulated BRDF data set presented within the file. For example, it can be brief information of what sample was measured, for what purpose and with which simulation model or instrument without giving all possible specific information. The idea of this field is to give short overview of the presented BRDF data in a way that user could understand with what kind of information he is dealing with without going into details presented in other \"metadata\" objects.",
"title": "description",
"type": "string"
},
"environment": {
"description": "By default it is an object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc. However, if data was acquired with the help of simulation/model, the \"environment\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"type": "object"
}
],
"title": "environment"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in URI format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"description": "By default it is an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. However, if data was acquired with the help of simulation/model, the \"instrumentation\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"type": "object"
}
],
"title": "instrumentation"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "The field to describe data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"enum": [
"simulation",
"measurement"
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"description": "An object with keys describing the virtual or actual sample used to produce BRDF data.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL link to schema of universal BRDF file format which name also specifies the schema version. Value has to be a string in URI format. Note that URL is part of uri (universal resource identifier (URI), according to RFC3986)",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"description": "By default it is an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. However, if data was acquired through the measurement without the help of any additional software the \"software\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"type": "object"
}
],
"title": "software"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"name",
"timestamp",
"provenance",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/aperture_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/aperture_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties of the aperture that is a part of the instrument used for BRDF measurement.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the aperture that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding aperture as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding aperture used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the aperture depending on its shape.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the aperture as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material from which aperture was produced as a text (i.e. string).",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the aperture given by manufacturr as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the aperture in a free form as a text (i.e. string).",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the aperture used for BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"type": {
"description": "Type of aperture used for BRDF measurement. For example, \"slit\", \"iris\", \"diaphragm\" etc. A a a text (i.e. string)",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"shape",
"dimensions"
],
"title": "aperture",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 11fe0190f2e38e8dc8697a37e88eda02ff64ccc0 | "2022-01-14T19:21:25" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and environment. It also contains a globally unique dataset identifier, specifies the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding BRDF data presented within the file. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A short description in the form of text (i.e. string) of the the measured or simulated BRDF data set presented within the file. For example, it can be brief information of what sample was measured, for what purpose and with which simulation model or instrument without giving all possible specific information. The idea of this field is to give short overview of the presented BRDF data in a way that user could understand with what kind of information he is dealing with without going into details presented in other \"metadata\" objects.",
"title": "description",
"type": "string"
},
"environment": {
"description": "By default it is an object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc. However, if data was acquired with the help of simulation/model, the \"environment\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"type": "object"
}
],
"title": "environment"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in URI format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"description": "By default it is an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. However, if data was acquired with the help of simulation/model, the \"instrumentation\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"type": "object"
}
],
"title": "instrumentation"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "The field to describe data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"enum": [
"simulation",
"measurement"
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"description": "An object with keys describing the virtual or actual sample used to produce BRDF data.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL link to schema of universal BRDF file format which name also specifies the schema version. Value has to be a string in URI format. Note that URL is part of uri (universal resource identifier (URI), according to RFC3986)",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"description": "By default it is an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. However, if data was acquired through the measurement without the help of any additional software the \"software\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"type": "object"
}
],
"title": "software"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"timestamp",
"provenance",
"description",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 0476cc0ee324e90cfba09ec6c244a1e60dbeb2b5 | "2022-02-11T02:25:22" | BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields.",
"properties": {
"comments": {
"description": "The field allowing to provide any additional and occasional information relevant to user-defined variable as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"description": "The field that allows to describe user-defined variable and its definition in a text (i.e. string) form. This field should be always present.",
"title": "description",
"type": "string"
},
"maximum": {
"description": "The field allowing to specify maximal allowed value of the user-defined numerical variable.",
"title": "maximum",
"type": "number"
},
"maximum_excluded": {
"default": false,
"description": "The field that allows to specify whether provided maximal value of the numerical user-defined variable is excluded from available values range or not. I.e. whether x is \"<\" or \"\u2264\" than minimal value provided in \"maximum\" field. \"true\" boolean value means it is excluded and \"false\" means it is included that is also a default value for this field.",
"title": "maximum_excluded",
"type": "boolean"
},
"minimum": {
"description": "The field allowing to specify minimal allowed value of the user-defined numerical variable.",
"title": "minimum",
"type": "number"
},
"minimum_excluded": {
"default": false,
"description": "The field that allows to specify whether provided minimal value of the numerical user-defined variable is excluded from available values range or not. I.e. whether x is \">\" or \"\u2265\" than minimal value provided in \"minimum\" field. \"true\" boolean value means it is excluded and \"false\" means it is included that is also a default value for this field.",
"title": "minimum_excluded",
"type": "boolean"
},
"name": {
"description": "The field allowing to provide a short name as a string that would briefly describe the nature of the user-defined variable. This field is not demanded, but might be useful if key under which \"adhoc_variable\" object is stored is not sufficient for the same purpose.",
"title": "name",
"type": "string"
},
"type": {
"description": "The field allowing to specify user-defined variable values' presentation type as for, example \"string\", \"number\", \"integer\", \"array of strings\", \"array of numbers\", \"array of integers\" or \"array of arrays of string/number/integer\" etc.",
"title": "type",
"type": "string"
},
"uncertainty": {
"description": "An object that allows to define non-varying uncertainty of the user-defined variable. The field is optional.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the user-defined variable as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
]
},
{
"additionalProperties": false,
"properties": {
"unit": {
"description": "Measurement unit of the single vector element of the varying uncertainty of the vectorized user-defined variable as a number.",
"title": "unit",
"type": "string"
},
"values": {
"description": "Array of numerical values of the non-varying uncertainties of the vectorized user-defined variable as a number.",
"items": {
"description": "Numerical value of the single vector element of the varying uncertainty of the vectorized user-defined variable as a number.",
"type": "number"
},
"title": "value",
"type": "array"
}
},
"required": [
"values",
"unit"
]
}
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the user-defined variable as a string.",
"title": "unit",
"type": "string"
},
"values": {
"description": "The field for storing array with values of user-defined variable. Array can have any type of entries except \"objects\". \"type\" of entry should be specified in the dedicated field.",
"items": {
"not": {
"type": "object"
}
},
"title": "values",
"type": "array"
}
},
"required": [
"description",
"unit",
"type",
"values"
],
"title": "adhoc_variable",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/license_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"properties": {
"email": {
"description": "E-mail of the natural or legal person who holds full rights for the presented data. String according to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"link": {
"description": "Link to the licence text applicable license as URL string.",
"format": "uri",
"title": "link",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of the natural or legal person who holds full rights for the presented data according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"proprietary": {
"description": "Text/string field allowing to provide text of the specific license or comments and additions to existing license template.",
"title": "proprietary",
"type": "string"
},
"rights_holder": {
"description": "Name of the natural or legal person who holds full rights for the presented data. As a string.",
"title": "rights_holder",
"type": "string"
},
"type": {
"description": "Field specifying license agreement applied to the presented datasets. This can be abbreviation according to \"Creative Commons\" license or short name of any other license. Information should be recorded as a string. Note that custom license text can be provided in \"proprietary\" field.",
"title": "type",
"type": "string"
}
},
"required": [
"type",
"rights_holder"
],
"title": "license",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | cf47e30c477bee57d0f23e88937012141314dc7c | "2022-02-10T18:14:00" | BRDF_JSON_schema/provenance_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"properties": {
"comments": {
"description": "Any additional iformation related to the provenance of the presented data in text form.",
"title": "comments",
"type": "string"
},
"contact_person": {
"description": "Name of the contact person representing the organization.",
"title": "contact_person",
"type": "string"
},
"email": {
"description": "Contact email of organization or its contact person. According to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"location": {
"additionalProperties": false,
"description": "Object that specifies physical location or address of organization that provided dataset recorded within the file.",
"properties": {
"building_nr": {
"description": "Street number of the building where organization is residing",
"title": "building_nr",
"type": "string"
},
"city": {
"description": "Name of the city where organization is located",
"title": "city",
"type": "string"
},
"coordinates": {
"description": "Organization location coordinates according to ISO 6709 standard",
"title": "coordinates",
"type": "string"
},
"country": {
"description": "Name of the country where organization is located",
"title": "country",
"type": "string"
},
"county": {
"description": "Name of the county within country where organization is located",
"title": "county",
"type": "string"
},
"postal_code": {
"description": "Postal code of organization's address.",
"title": "postal_code",
"type": "string"
},
"room_nr": {
"description": "Laboratory or the room number within the organization's building",
"title": "room_nr",
"type": "string"
},
"street": {
"description": "Name of the street within city where organization is located",
"title": "street",
"type": "string"
}
},
"required": [
"country",
"city",
"street",
"building_nr",
"postal_code"
],
"title": "location",
"type": "object"
},
"organization": {
"description": "Name of the company, organization, institution, university etc. that produced the dataset recorded within the file.",
"title": "organization",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of organization or its contact person according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"website": {
"description": "URL of the organization/institution's web-page if available.",
"format": "uri",
"title": "website",
"type": "string"
}
},
"required": [
"organization",
"location",
"email",
"contact_person"
],
"title": "provenance",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and environment. It also contains a globally unique dataset identifier, specifies the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding BRDF data presented within the file. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"environment": {
"description": "By default it is an object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc. However, if data was acquired with the help of simulation/model, the \"environment\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/environment_json_schema_v1.0.json",
"type": "object"
}
],
"title": "environment"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in URI format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"description": "By default it is an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. However, if data was acquired with the help of simulation/model, the \"instrumentation\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/instrumentation_json_schema_v1.0.json",
"type": "object"
}
],
"title": "instrumentation"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "The field to describe data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"enum": [
"simulation",
"measurement"
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"description": "An object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_json_schema_v1.0.json",
"description": "An object with keys describing the virtual or actual sample used to produce BRDF data.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL link to schema of universal BRDF file format which name also specifies the schema version. Value has to be a string in URI format. Note that URL is part of uri (universal resource identifier (URI), according to RFC3986)",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"description": "By default it is an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. However, if data was acquired through the measurement without the help of any additional software the \"software\" object might be obsolete in which case it is allowed to replace object with a string that has constant value \"NA\" meaning \"not applicable\".",
"oneOf": [
{
"enum": [
"NA"
],
"type": "string"
},
{
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"type": "object"
}
],
"title": "software"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"name",
"timestamp",
"provenance",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/detection_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/detection_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the detection system used for BRDF measurements that cannot be presented within \"detection_system\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding detection system used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding detection system used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"distance_from_sample": {
"additionalProperties": false,
"description": "An object describing detection system's distance from the sample surface. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of detection system's distance from the sample surface as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\", \"Gm\" or \"%\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the detection system's distance from the sample surface as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"enum": [
"pm",
"nm",
"\u03bcm",
"mm",
"dm",
"m",
"km",
"Mm",
"Gm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's distance from the sample surface as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "distance_from_sample",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the detection system used for BRDF measurements as a text (i.e. string).",
"title": "name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of the detector used for BRDF measurements. Array contains unique \"polarization_alterant\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to detect light scattered from the sample with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array",
"uniqueItems": true
},
"sensors": {
"description": "An array of unique objects describing optical sensors of detection system of the instrument used for BRDF measurements. Array contains unique \"sensor\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"title": "sensor",
"type": "object"
},
"title": "sensors",
"type": "array",
"uniqueItems": true
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the detection system's viewing solid angle uncertainty as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the detection system's viewing solid angle uncertainty as a string that can have values \"sr\" or \"%\".",
"enum": [
"sr",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the detection system's viewing solid angle as a string that can have values \"sr\".",
"enum": [
"sr"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the detection system's viewing solid angle as a positive number from 0 to 12.57 (i.e. from 0 to 4\u03c0 limits included). Shortly: 0 \u2264 x \u2264 12.57",
"maximum": 12.57,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"viewed_area": {
"additionalProperties": false,
"description": "An object describing detection system's viewing solid angle in steradians. It is an object with keys \"shape\" and \"dimensions\".",
"properties": {
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the area viewed by detection system during BRDF measurements.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"shape": {
"description": "Shape of the area viewed by detection system during BRDF measurements as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
}
},
"required": [
"shape",
"dimensions"
],
"title": "viewed_area",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges for detection as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"sensors",
"solid_angle"
],
"title": "detection_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | "2021-11-26T18:53:57" | BRDF_JSON_schema/software_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/software_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the software as well as the mathematical/physical simulation model and its parameters used to produce or process BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"software\" object) describing any information relevant to the software and simulation model that were used to produce or process BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"author": {
"description": "Person or company name that developed the software used to produce or process BRDF data as a text (i.e. string).",
"title": "author",
"type": "string"
},
"comments": {
"description": "A section that allows to add any additional information regarding the software and simulation model that were used to produce or process BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the software and simulation model that were used to produce or process BRDF data presented in the file.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the the software used to produce or process BRDF data as a text (i.e. string). For exmple, \"Ray-tracing software for optical reflectance simulation.\" or \"Matlab script for calculation BRDF values and its uncertainty from measurement results and known instrumental parameters.\"",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "name",
"type": "string"
},
"simulation_model": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/simulation_model_json_schema_v1.0.json",
"description": "An object describing physical or mathematical simulation model that was used to generate BRDF values presented in the file.",
"title": "simulation_model",
"type": "object"
},
"version": {
"description": "Version of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "version",
"type": "string"
}
},
"required": [
"name"
],
"title": "software"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"oneOf": [
{
"required": [
"wl_range",
"bandpass_FWHM"
]
},
{
"required": [
"selected_wl",
"bandpass_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator parameters used during BRDF measurements that cannot be presented within \"monochromator_setting\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bandpass_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of spectral band passed through monochromator. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's bandpass FWHM as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's bandpass FWHM as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's bandpass FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's bandpass FWHM as a zero (0) inclusive positive number (x \u2265 0)..",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bandpass_FWHM",
"type": "object"
},
"central_wl_uncertainty": {
"additionalProperties": false,
"description": "An object describing the average uncertainty of the monochromator's transmitted band central wavelength value within a given wavelength range. It is an object with following available keys: \"value\", \"unit\".",
"properties": {
"unit": {
"description": "Measurement unit of the average uncertainty of the monochromator's transmitted band central wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the average uncertainty of the monochromator's transmitted band central wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"comments": {
"description": "A field allowing to describe any additional information related to monochromator settings as a text (i.e. string)",
"title": "comments",
"type": "string"
},
"selected_dispersive_element": {
"description": "Name and/or type of the selected monochromator's wavelength dispersive element as text (i.e. string). For example, \"diffraction grating designed for visible wavelength region\" or \"volumetric Bragg grating designed for NIR wavelength region\".",
"title": "selected_dispersive_element",
"type": "string"
},
"selected_wl": {
"additionalProperties": false,
"description": "Wavelength that was selected at monochromator settings for single-wavelength BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the set monochromator's wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the set monochromator's wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the set monochromator's wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the set monochromator's wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "selected_wl",
"type": "object"
},
"slit_width": {
"additionalProperties": false,
"description": "Slit width of the monochromator for the given wavelength range. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's slit width as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\", \"m\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"mm",
"m",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's slit width as a string that can have values \"nm\", \"\u03bcm\", \"mm\" or \"m\".",
"enum": [
"nm",
"\u03bcm",
"mm",
"m"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's slit width as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "slit_width",
"type": "object"
},
"spectral_resolution": {
"additionalProperties": false,
"description": "Description of monochromator's wavelength resolving/separation/dispersion capabilities as width of transmitted light spectral band per width of monochromator output slit. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the monochromator's wavelength resolving/separation/dispersion capabilities as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\" or \"%\".",
"enum": [
"nm/mm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the monochromator's wavelength resolving/separation/dispersion capabilities as a string that can have value \"nm/mm\".",
"enum": [
"nm/mm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the monochromator's wavelength resolving/separation/dispersion capabilities as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "spectral_resolution",
"type": "object"
},
"wl_range": {
"additionalProperties": false,
"description": "Design or set operation wavelength range of the monochromator used to select illumination or detection wavelength during BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the monochromator's transmission longest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the monochromator's transmission shortest wavelength as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the monochromator's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "monochromator_setting",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/monochromator_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/monochromator_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties and set parameters of the monochromator included to the set-up used for (usually spectral) BRDF measurements. Note that the same object describes monochromators integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator used for illumination or detection light wavelength selection during BRDF measurements that cannot be presented within \"monochromator\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section for providing any relevant information regarding monochromator used during BRDF measurements as a string/text.",
"title": "comments",
"type": "string"
},
"damage_treshold": {
"additionalProperties": false,
"description": "Field for indication of maximum optical power at which monochromator was designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum optical power at which monochromator was designed to be operated without damage as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold",
"type": "object"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding monochromator used during BRDF measurements. Array of text (i.e.string) URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the monochromator used for BRDF measurements. As a text (i.e.string).",
"title": "name",
"type": "string"
},
"settings": {
"description": "And array with objects that describes monochromator settings for a single selected wavelength or different wavelength ranges that were used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/monochromator_setting_json_schema_v1.0.json",
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"title": "monochromator_setting",
"type": "object"
},
"title": "settings",
"type": "array"
},
"type": {
"description": "Type of the monochromator used to select illumination or detection wavelength during BRDF measurements. For example \"prism based monochromatror\", \"double monochromator\" etc. As a text (i.e.string).",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"settings"
],
"title": "monochromator",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single polarization altering element or an assembly that included to the set-up used for (usually polarimetric) BRDF measurements. Note that the same object describes polarization altering elements integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the polarization altering element included to the of the set-up used for (usually polarimetric) BRDF measurements that cannot be presented within \"polarization_alterant\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "The field describing maximum power at which polarization altering element can be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximum power at which polarization altering element can be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum power at which polarization altering element can be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold",
"type": "object"
},
"data_links": {
"description": "An array with links to any relevant technical information regarding polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"design_wl": {
"additionalProperties": false,
"description": "An object describing wavelength at which polarization altering element is most effective by design. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength at which polarization altering element is most effective as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength at which polarization altering element is most effective as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "design_wl",
"type": "object"
},
"extinction_ratio": {
"additionalProperties": false,
"description": "The field to describe typical extinction ratio of polarizer used for altering polarization of illumination. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the polarizer's extinction ratio as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Polarizer's extinction ratio uncertainty measurement unit can be expressed as unitless (i.e. empty string \"\"),\"%\" or \"dB\".",
"enum": [
"",
"%",
"dB"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Polarizer's extinction ratio measurement unit can be expressed as unitless (i.e. empty string \"\"),\"%\" and \"dB\".",
"enum": [
"",
"%",
"dB"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the polarizer's extinction ratio as a zero (0) inclusive positive number (x \u2265 0). Note that extinction ratio is usually presented as X : 1, but since 1 is a constant only X is the value requested here.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_ratio",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the polarization altering element as a text/string.",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Field describing the material of polarization altering element as a text/string.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model name of the polarization altering element given by manufacturer. As a text/string.",
"title": "model",
"type": "string"
},
"name": {
"description": "Short name of an element used for alteration of illumination or detection polarization state. As a text/string.",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of the polarization altering element. For example, \"linear polarizer\", \"quater-wave plate\", \"half-wave plate\", \"retarder\", \"depolarizer\" etc. As a text/string.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "Wavelength range within which polarization altering element is designed to be operated. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength at which polarization altering element can be used as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of shortest wavelength at which polarization altering element can be used as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the shortest and longest wavelengths at which polarization altering element can be used as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"required": [
"name",
"type"
],
"title": "polarization_alterant",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/software_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/software_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the software as well as the mathematical/physical simulation model and its parameters used to produce or process BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"software\" object) describing any information relevant to the software and simulation model that were used to produce or process BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"author": {
"description": "Person or company name that developed the software used to produce or process BRDF data as a text (i.e. string).",
"title": "author",
"type": "string"
},
"comments": {
"description": "A section that allows to add any additional information regarding the software and simulation model that were used to produce or process BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the software and simulation model that were used to produce or process BRDF data presented in the file.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the the software used to produce or process BRDF data as a text (i.e. string). For exmple, \"Ray-tracing software for optical reflectance simulation.\" or \"Matlab script for calculation BRDF values and its uncertainty from measurement results and known instrumental parameters.\"",
"title": "description",
"type": "string"
},
"name": {
"description": "Name of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "name",
"type": "string"
},
"simulation_model": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_json_schema_v1.0.json",
"description": "An object describing physical or mathematical simulation model that was used to generate BRDF values presented in the file.",
"title": "simulation_model",
"type": "object"
},
"version": {
"description": "Version of the software used to produce or process BRDF data as a text (i.e. string).",
"title": "version",
"type": "string"
}
},
"required": [
"name"
],
"title": "software"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | "2021-11-26T18:53:57" | BRDF_JSON_schema/simulation_model_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/simulation_model_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the mathematical or physical simulation model and its parameters used to produce BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"simulation_model\" object) describing any information relevant to the mathematical or physical simulation model used to produce BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the mathematical or physical simulation model used to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the mathematical or physical simulation model that were used to produce BRDF data presented in the file. For example, link to the article describing model.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). It may refer to authors of model, its key principles, description of most significant variables, application limits etc.",
"title": "description",
"type": "string"
},
"equation": {
"description": "Equation of mathematical or physical simulation model used to produce BRDF data as a text (i.e. string) according to text-based math standards: https://w3c.github.io/mathonwebpages/research/text_based_standards.html. NB! Correct spelling of math equations cannot be checked by JSON validator.",
"title": "equation",
"type": "string"
},
"name": {
"description": "Short name commonly used to refer to mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). For example, \"Torrance-Sparrow model\", \"Cook-Torrance model\" etc.",
"title": "name",
"type": "string"
},
"parameters": {
"description": "An array of objects describing mathematical or physical simulation model parameters.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/simulation_model_parameter_json_schema_v1.0.json",
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"title": "model_parameter",
"type": "object"
},
"title": "parameters",
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"description"
],
"title": "simulation_model"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/instrumentation_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/instrumentation_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the setup or instrumentation as well as its parameters that were used to measure BRDF data presented in the file.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"instrumentation\" object) describing any information relevant to the instrumentation used for BRDF measurement. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to instrumentation used for BRDF measurement.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding setup or instrumentation used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"detection_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/detection_system_json_schema_v1.0.json",
"description": "An object with keys describing detector and its accompanying relevant optical components and and settings.",
"title": "detection",
"type": "object"
},
"firmware_version": {
"description": "Version of the firmware used to operate the instrument or system during the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "firmware_version",
"type": "string"
},
"illumination_system": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/illumination_system_json_schema_v1.0.json",
"description": "An object with keys describing illumination source, relevant optical components and illumination beam properties.",
"title": "illumination",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the instrument or system used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the instrument or system that was used for the measurement of BRDF data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the instrument or system that was used for the measurement of BRDF data presented within the file.",
"title": "name",
"type": "string"
},
"operation_type": {
"description": "The key describing whether instrument performs measurements absolutely or relatively. Can have string values \"absolute\" and \"relative\".",
"oneOf": [
{
"const": "absolute"
},
{
"const": "relative"
}
],
"title": "operation_type",
"type": "string"
},
"operator_name": {
"description": "Name of the person who performed BRDF measurements presented within file as a string.",
"title": "operator_name",
"type": "string"
},
"reference_info": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/reference_info_json_schema_v1.0.json",
"description": "An object describing reference sample and related data used for relative BRDF measurements.",
"title": "reference_info",
"type": "object"
},
"serial_number": {
"description": "Serial number of the instrument or system that was used for the measurement of BRDF data presented within the file. As a text (i.e. string).",
"title": "serial_number",
"type": "string"
}
},
"required": [
"name",
"illumination",
"detection"
],
"title": "instrumentation",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 0dd8bf77f32af8ad092a4cf3940b18c3ef900dff | "2022-01-13T13:24:52" | BRDF_JSON_schema/license_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/license_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"properties": {
"email": {
"description": "E-mail of the natural or legal person who holds full rights for the presented data. String according to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"link": {
"description": "Link to the licence text applicable license as URL string.",
"format": "uri",
"title": "link",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of the natural or legal person who holds full rights for the presented data according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"proprietary": {
"description": "Text/string field allowing to provide text of the specific license or comments and additions to existing license template.",
"title": "proprietary",
"type": "string"
},
"rights_holder": {
"description": "Name of the natural or legal person who holds full rights for the presented data. As a string.",
"title": "rights_holder",
"type": "string"
},
"type": {
"description": "Field specifying license agreement applied to the presented datasets. This can be an abbreviation according to \"Creative Commons\" license or short name of any other license. Information should be recorded as a string. Note that custom license text can be provided in \"proprietary\" field.",
"title": "type",
"type": "string"
}
},
"required": [
"type",
"rights_holder"
],
"title": "license",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 0f5de59eb290093f9d68141f782eb4e037fdab45 | "2022-01-15T11:33:59" | BRDF_JSON_schema/data_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/data_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties/fields that allow to describe variables of BRDF function and provide their values alongside BRDF values themselves.",
"properties": {
"BRDF": {
"additionalProperties": false,
"description": "An object describing and providing the bidirectional reflectance distribution function \"BRDF\" values as defined by F. E. Nicodemus. I.e. BRDF values are measured in sr^\u22121 (1/sr) and can vary from 0 sr^\u22121 to inf. sr^\u22121.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"BRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of \"BRDF\" values. It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of \"BRDF\" values as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of \"BRDF\" values as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the \"BRDF\" values. Allowed values are strings \"1/sr\" or \"sr^-1\".",
"enum": [
"1/sr",
"sr^-1"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of measured or simulated \"BRDF\" values corresponding to set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "BRDF",
"type": "object"
},
"adhoc_variables": {
"additionalProperties": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/adhoc_varible_json_schema_v1.0.json",
"description": "An object describing a single additional BRDF variable defined by the user. It should have at least \"description\", \"unit\" and \"values\" fields. It is also advised to place \"adhoc_variable\" object under such \"adhoc_variables\" key that would shortly describe the nature of the user defined variable.",
"title": "adhoc_variable",
"type": "object"
},
"description": "An object containing properties/fields describing user defined BRDF variables. For example, solid angle or illumination/observation spot spatial coordinates if they were varied during BRDF measurements. Most successful variable definitions might become standard definitions and will be included to default parameters of future versions of universal BRDF file format schema.",
"title": "adhoc_variables",
"type": "object"
},
"phi_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence azimuthal angle \"phi_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence azimuthal angle \"phi_i\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to illumination incidence azimuthal angle \"phi_i\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence azimuthal angle \"phi_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence azimuthal angle.",
"description": "The field providing the short description of the \"phi_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_i",
"description": "The field providing the short name of the illumination light incidence azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence azimuthal angle \"phi_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence azimuthal angle \"phi_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence azimuthal angle \"phi_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_i",
"type": "object"
},
"phi_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation azimuthal angle \"phi_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation azimuthal angle \"phi_r\" can be varied from 0\u00b0 to 360\u00b0 (0 to \u03c0/2 rad) around the sample's normal starting from the direction defined by the user (mark on the sample) and ending at the direction. To avoid overlapping data present file format does not allow to reflected light observation azimuthal angle \"phi_r\" to have values equal or greater than 360\u00b0.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 360
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation azimuthal angle \"phi_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation azimuthal angle.",
"description": "The field providing the short description of the \"phi_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "phi_r",
"description": "The field providing the short name of the reflected light observation azimuthal angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation azimuthal angle \"phi_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation azimuthal angle \"phi_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation azimuthal angle \"phi_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 360\u00b0 (i.e. up to 2\u03c0 radians) that is excluded. Shortly: 0 \u2264 x < 360\u00b0 (or 2\u03c0).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"values",
"unit"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 3.141593
}
}
}
},
"title": "phi_r",
"type": "object"
},
"polarization_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the illumination light polarization state \"polarization_i\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of incidence (https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of incidence is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of incidence and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is illuminated under 0\u00b0 illumination zenith angle \"theta_i\", then it is advised to define plane of incidence using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_i\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light polarization state \"polarization_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light polarization state.",
"description": "The field providing the short description of the \"polarization_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_i",
"description": "The field providing the short name of the illumination light polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe illumination light polarization state \"polarization_i\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light polarization state \"polarization_i\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the illumination light polarization state \"polarization_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"notation",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_i",
"type": "object"
},
"polarization_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the reflected light observation polarization state \"polarization_r\" and provide its values. Polarization state can be presented using two different notations: sp-notation for the simplest (linear) cases of polarization state and intensity-normalized Stokes vector notation (https://en.wikipedia.org/wiki/Stokes_parameters) allowing to present arbitrary polarization state as well as degree of polarization. In both cases polarization coordinate frame is defined in respect to plane of reflectance (i.e. plane defined by the direction of reflectance observation and measurement sample's normal similarly to the plane of incidence - https://en.wikipedia.org/wiki/Plane_of_incidence) where polarized light with its electric field along the plane of reflectance is denoted as p-polarized and have Stokes's vector corresponding to vertical linear polarization state [1, -1, 0, 0] i.e. vertical polarization orientation changes with sample's normal orientation. S-polarized light electric field is normal to the plane of reflectance and corresponding Stokes vector denotes horizontal linear polarization [1, 1, 0, 0]. If sample is observed under 0\u00b0 reflectance observation zenith angle \"theta_r\", then it is advised to define plane of reflectance using sample's normal and 0\u00b0 azimuthal angle direction (usually marked on the sample). Any specific coordinate frame definitions can be noted in the \"comments\" field of \"polarization_r\" object.",
"else": {
"properties": {
"values": {
"items": {
"items": false,
"prefixItems": [
{
"const": 1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
},
{
"maximum": 1,
"minimum": -1,
"type": "number"
}
],
"type": "array"
}
}
}
},
"if": {
"properties": {
"notation": {
"const": "sp"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation polarization state \"polarization_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light observation polarization state.",
"description": "The field providing the short description of the \"polarization_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "polarization_r",
"description": "The field providing the short name of the reflected light observation polarization state variable as a string.",
"title": "name",
"type": "string"
},
"notation": {
"description": "The field that allows to specify the notation used to describe reflected light observation polarization state \"polarization_r\" as a string. Allowed values are strings \"sp\" and \"nStokes\" corresponding to sp-notation and intensity-normalized Stokes notation (i.e. Stokes vector first component denoting total intensity of the beam is always equal to 1 and all vector parameters are unitless).",
"enum": [
"sp",
"inStokes"
],
"title": "notation",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation polarization state \"polarization_r\" presented in intensity-normalized Stokes notation. It is an object with \"values\" and \"units\" keys.",
"properties": {
"units": {
"description": "An array that specifies measurement units of the non-varying uncertainties of each Stokes' vector components (4 in total) presented as a string that can have values: \"\" and \"%\".",
"items": false,
"prefixItems": [
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
},
{
"enum": [
"",
"%"
],
"type": "string"
}
],
"title": "units",
"type": "array"
},
"values": {
"description": "An array with numerical values of non-varying uncertainties of each Stokes' vector components (4 in total) presented as a zero (0) inclusive positive numbers (0 \u2264 x < inf).",
"items": false,
"prefixItems": [
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
},
{
"minimum": 0,
"type": "number"
}
],
"title": "values",
"type": "array"
}
},
"required": [
"values",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"values": {
"description": "An array containing numerical values of the reflected light observation polarization state \"polarization_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain either strings with values of \"p\", \"s\" and \"u\" corresponding to p-, s-polarized and unpolarized states or arrays (Stokes vectors) that have 4 numerical components from which first is always 1 and 3 others can vary from -1 to 1 (see intensity-normalized Stokes vector definition https://en.wikipedia.org/wiki/Polarization_(waves)).",
"title": "values",
"type": "array"
}
},
"required": [
"notation",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"enum": [
"s",
"p",
"u"
],
"type": "string"
}
}
}
},
"title": "polarization_r",
"type": "object"
},
"theta_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light incidence zenith angle \"theta_i\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the illumination incidence zenith angle \"theta_i\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light incidence zenith angle \"theta_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light/beam incidence zenith angle.",
"description": "The field providing the short description of the \"theta_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_i",
"description": "The field providing the short name of the illumination light incidence zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light incidence zenith angle \"theta_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light incidence zenith angle \"theta_i\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light incidence zenith angle \"theta_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to \u03c0/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_i",
"type": "object"
},
"theta_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to reflected light observation zenith angle \"theta_r\" and provide its values. By definition of BRDF function first presented by F. E. Nicodemus, the reflected light observation zenith angle \"theta_r\" can be varied from 0\u00b0 to 90\u00b0 (0 to \u03c0/2 rad) starting from the measurements sample's normal and ending at the surface parallel to sample's surface.",
"else": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 90
}
}
}
},
"if": {
"properties": {
"unit": {
"const": "rad"
}
}
},
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to reflected light observation zenith angle \"theta_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Reflected light/beam observation zenith angle.",
"description": "The field providing the short description of the \"theta_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "theta_r",
"description": "The field providing the short name of the reflected light observation zenith angle variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a string that can have values: \"rad\", \"deg\", \"\u00b0\" and \"%\".",
"enum": [
"rad",
"deg",
"\u00b0",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the reflected light observation zenith angle \"theta_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the reflected light observation zenith angle \"theta_r\". Allowed values are strings \"rad\", \"deg\" or \"\u00b0\".",
"enum": [
"rad",
"deg",
"\u00b0"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the reflected light observation zenith angle \"theta_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers up to maximal value of 90\u00b0 (i.e. up to \u03c0/2 radians). Shortly: 0 \u2264 x \u2264 90\u00b0 (or \u03c0/2).",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"then": {
"properties": {
"values": {
"items": {
"exclusiveMaximum": 1.5708
}
}
}
},
"title": "theta_r",
"type": "object"
},
"uBRDF": {
"additionalProperties": false,
"description": "An object that describes the variable corresponding to non-constant uncertainty of bidirectional reflectance distribution function values \"uBRDF\". I.e. BRDF associated uncertainty that varies with BRDF function parameters/variables. It is a complex quantity that might be affected by the uncertainties of all the variables used for BRDF estimation and most probably is unique for different measurement instruments and simulation models. BRDF uncertainty should be presented in sr^-1 (1/sr) if it is absolute or in % if relative.",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to uncertainty of the bidirectional reflectance distribution function \"BRDF\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Uncertainty of bidirectional reflectance distribution function.",
"description": "The field providing the short description of the \"uBRDF\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "BRDF",
"description": "The field providing the short name of the uncertainty of bidirectional reflectance distribution function as a string.",
"title": "name",
"type": "string"
},
"unit": {
"description": "The field that allows to specify measurement unit uncertainty of bidirectional reflectance distribution function values \"uBRDF\" as a string that can have values: \"1/sr\", \"sr^-1\" and \"%\".",
"enum": [
"1/sr",
"sr^-1",
"%"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the measured or simulated \"BRDF\" uncertainty estimated for each set of parameters stored in other properties of \"data\" object (i.e. objects under \"data\" object keys describing BRDF function parameters and their values). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "uBRDF",
"type": "object"
},
"wavelength_i": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to illumination light wavelength \"wavelength_i\" and provide its values. This parameter is relevant for spectral BRDF measurements where monochromatic illumination is used and its wavelength is set before the light hits the sample. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to illumination light wavelength \"wavelength_i\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Illumination light wavelength.",
"description": "The field providing the short description of the \"wavelength_i\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_i",
"description": "The field providing the short name of the illumination light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the illumination light wavelength \"wavelength_i\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the illumination light wavelength \"wavelength_i\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the illumination light wavelength \"wavelength_i\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the illumination light wavelength \"wavelength_i\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_i",
"type": "object"
},
"wavelength_r": {
"additionalProperties": false,
"description": "An object that allows to describe the variable corresponding to the observed reflected light wavelength \"wavelength_r\" and provide its values. This parameter is relevant for spectral BRDF measurements where light reflected from the sample is spectrally resolved prior its detection by the sensor. Wavelength can be presented in nanometers \"nm\" or micrometers \"\u03bcm\".",
"properties": {
"comments": {
"description": "The field allowing to specify any additional information relevant to the observed reflected light wavelength \"wavelength_r\" and its values as a text (i.e. string).",
"title": "comments",
"type": "string"
},
"description": {
"const": "Observed reflected light wavelength.",
"description": "The field providing the short description of the \"wavelength_r\" variable as a string.",
"title": "description",
"type": "string"
},
"name": {
"const": "wavelength_r",
"description": "The field providing the short name of the observed reflected light wavelength variable as a string.",
"title": "name",
"type": "string"
},
"uncertainty": {
"additionalProperties": false,
"description": "The field containing an object that allows to specify the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\". It is an object with \"value\" and \"unit\" keys.",
"properties": {
"unit": {
"description": "Measurement unit of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a string that can have values: \"nm\", \"\u03bcm\" and \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the non-varying uncertainty of the observed reflected light wavelength \"wavelength_r\" as a zero (0) inclusive positive number (0 \u2264 x < inf).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uncertainty",
"type": "object"
},
"unit": {
"description": "The field that allows to specify measurement unit of the observed reflected light wavelength \"wavelength_r\". Allowed values are strings \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"values": {
"description": "An array containing numerical values of the observed reflected light wavelength \"wavelength_r\" used to measure/simulate each BRDF point/value presented in \"values\" of \"data\" \"BRDF\" object (i.e. under \"BRDF\" key). Array can contain only zero (0) inclusive positive numbers. Shortly: 0 \u2264 x < inf.",
"items": {
"minimum": 0,
"type": "number"
},
"title": "values",
"type": "array"
}
},
"required": [
"unit",
"values"
],
"title": "wavelength_r",
"type": "object"
}
},
"required": [
"theta_i",
"phi_i",
"theta_r",
"phi_r",
"BRDF"
],
"title": "data",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/source_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/source_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes illumination source that was used for BRDF measurements.",
"oneOf": [
{
"required": [
"name",
"type",
"power",
"wl_range"
]
},
{
"required": [
"name",
"type",
"power",
"central_wl"
]
}
],
"properties": {
"CIE_notation": {
"description": "Field that allows to classify light source according to CIE abbreviations for standard illuminants. It accommodates text (i.e.string) values corresponding only to CIE abbreviations. For information about values see https://en.wikipedia.org/wiki/Standard_illuminant.",
"enum": [
"A",
"B",
"C",
"D50",
"D55",
"D65",
"D75",
"D93",
"E",
"F1",
"F2",
"F3",
"F4",
"F5",
"F6",
"F7",
"F8",
"F9",
"F10",
"F11",
"F12",
"LED-B1",
"LED-B2",
"LED-B3",
"LED-B4",
"LED-B5",
"LED-B1",
"LED-BH1",
"LED-RGB1",
"LED-V2"
],
"title": "CIE_notation",
"type": "string"
},
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination source of the instrument that cannot be presented within \"source\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "Property describing the central wavelength of illumination light source. It is most relevant for lasers and narrow-band LEDs. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source central wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source central wavelength as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source central wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"color_temperature": {
"additionalProperties": false,
"description": "The field allowing to specify color temperature of black-body radiator if it was used for BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source color temperature as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source color temperature as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source color temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source color temperature as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "color_temperature",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding illumination source that was used for BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding light source used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "The property that allows to specify the manufacturer of the light source that used for BRDF measurements. For example, company or workshop name written as a text (i.e.string)",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "The property that allows to specify the model of the illumination source that was used for BRDF measurements. It can be written as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the light source that was used for BRDF measurements. Can be written in a free form as a text (string).",
"title": "name",
"type": "string"
},
"operating_current": {
"additionalProperties": false,
"description": "An object describing the current at which illumination source was operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating current as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"%\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\" or \"GA\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating current as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_current",
"type": "object"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light source was operated. Might be relevant in case of cooled light sources or lasers/LEDs which central wavelength can change with temperature. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating temperature as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating temperature as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating temperature as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating temperature as a number. In allowed units the minimum allowed value is \u2212273.15 (if in \u00b0C).",
"minimum": -273.15,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_temperature",
"type": "object"
},
"operating_voltage": {
"additionalProperties": false,
"description": "An object describing the voltage at which illumination source was operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source operating voltage as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\" or \"%\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source operating voltage as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source operating voltage as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "operating_voltage",
"type": "object"
},
"power": {
"additionalProperties": false,
"description": "The property describing integral power of the illumination source in power units like W, kW, mW etc. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the illumination source power as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the illumination source power as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the illumination source power as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "power",
"type": "object"
},
"type": {
"description": "The field that specifies what type of illumination source was used for BRDF measurements. For example it can be laser, incandescent lamp, black-body, LED etc. String values are allowed.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "An object allowing to specify the wavelength range within which illumination source radiates. Most relevant for wide-band sources as incandescent lamps, fluorescent lamps, black-bodies etc. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the illumination source longest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the illumination source shortest wavelength as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the illumination source shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"title": "source",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | "2021-11-26T18:53:57" | BRDF_JSON_schema/environment_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/environment_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the environmental conditions during BRDF measurement like pressure, temperature, humidity, etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the environmental conditions during BRDF measurements that cannot be presented within \"environment\" object properties provided by schema. Adhoc section can contain all types of entries except new objects",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding environmental conditions during BRDF measurements. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external information regarding environmental conditions during BRDF measurements. Array of string URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"pressure": {
"additionalProperties": false,
"description": "An object describing pressure within the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative pressure within the environment in which measurement sample's BRDF was measured as a string that can have value \"Pa\", \"kPa\", \"bar\" and \"psi\".",
"enum": [
"Pa",
"kPa",
"bar",
"psi"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the pressure within the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "pressure",
"type": "object"
},
"relative_humidity": {
"additionalProperties": false,
"description": "An object describing relative humidity of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the relative humidity of the environment in which measurement sample's BRDF was measured as a string that can have value \"%\".",
"enum": [
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the relative humidity of the environment (at the given temperature) in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "relative_humidity",
"type": "object"
},
"temperature": {
"additionalProperties": false,
"description": "An object describing ambient temperature of the environment in which measurement sample's BRDF was measured.",
"properties": {
"unit": {
"description": "Unit of the ambient temperature of the environment in which measurement sample's BRDF was measured as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the ambient temperature of the environment in which measurement sample's BRDF was measured as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "temperature",
"type": "object"
}
},
"required": [
"temperature"
],
"title": "environment",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/simulation_model_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing the mathematical or physical simulation model and its parameters used to produce BRDF data.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"simulation_model\" object) describing any information relevant to the mathematical or physical simulation model used to produce BRDF data presented in the file. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to add any additional information regarding the mathematical or physical simulation model used to produce BRDF data presented in the file. Comments should be presented as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array of links (as a string) in URI format that allow to refer to any external information related to the mathematical or physical simulation model that were used to produce BRDF data presented in the file. For example, link to the article describing model.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "Short description of the mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). It may refer to authors of model, its key principles, description of most significant variables, application limits etc.",
"title": "description",
"type": "string"
},
"equation": {
"description": "Equation of mathematical or physical simulation model used to produce BRDF data as a text (i.e. string) according to text-based math standards: https://w3c.github.io/mathonwebpages/research/text_based_standards.html. NB! Correct spelling of math equations cannot be checked by JSON validator.",
"title": "equation",
"type": "string"
},
"name": {
"description": "Short name commonly used to refer to mathematical or physical simulation model used to produce BRDF data as a text (i.e. string). For example, \"Torrance-Sparrow model\", \"Cook-Torrance model\" etc.",
"title": "name",
"type": "string"
},
"parameters": {
"description": "An array of objects describing mathematical or physical simulation model parameters.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/simulation_model_parameter_json_schema_v1.0.json",
"description": "An object describing a single mathematical or physical simulation model parameter. I.e. its name, meaning, value, unit, symbol etc.",
"title": "model_parameter",
"type": "object"
},
"title": "parameters",
"type": "array",
"uniqueItems": true
}
},
"required": [
"name",
"description"
],
"title": "simulation_model"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/metadata_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/metadata_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A section of a file that describes the measured or simulated BRDF data set from the point of view of data origin, simulation or measurement system's parameters, sample parameters and evironment. It also contains a globaly unique dataset identifier, specifices the data type, file name and records a timestamp of a measurement or simulation",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys describing any information relevant to the BRDF data which cannot be presented within metadata objects provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "String describing any additional information or comment related to BRDF measurement data.",
"title": "comments",
"type": "string"
},
"environment": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/environment_json_schema_v1.0.json",
"description": "String or an object with keys describing the environmental conditions during BRDFmeasurement like pressure, temperature, humidity, etc. Object has values as a number or a string.",
"title": "environment",
"type": "object"
},
"id": {
"description": "A universal resource identifier (URI), according to RFC3986. String in uri format",
"format": "uri",
"title": "id",
"type": "string"
},
"instrumentation": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/instrumentation_json_schema_v1.0.json",
"description": "String or an object with keys describing the setup or instrumentation and its parameters used to measure BRDF data. Object has values as a number or a string.",
"title": "instrumentation",
"type": "object"
},
"license": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/license_json_schema_v1.0.json",
"description": "An object providing all relevant information regarding the license applicable for presented BRDF data.",
"title": "license",
"type": "object"
},
"method": {
"description": "Data acquisition method that specifies whether data was simulated or measured. Can have two string values: \"simulation\" or \"measurement\"",
"oneOf": [
{
"const": "simulation"
},
{
"const": "measurement"
}
],
"title": "method",
"type": "string"
},
"provenance": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/provenance_json_schema_v1.0.json",
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"title": "description",
"type": "object"
},
"sample": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/sample_json_schema_v1.0.json",
"description": "String or an object with keys describing the virtual or actual sample used to produce BRDF data. Object has values as a number or a string.",
"title": "sample",
"type": "object"
},
"schema": {
"description": "URL to schema of universal BRDF file format which name also specifies the schema version. As a string in uri format.",
"format": "uri",
"title": "schema",
"type": "string"
},
"software": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/software_json_schema_v1.0.json",
"description": "String or an object with keys describing the mathematical/physical simulation model and its parameters used to produce BRDF data. Object has values as a number or a string.",
"title": "software",
"type": "object"
},
"timestamp": {
"description": "Timestamp of measurement or simulation as a string in the format of YYYY-MM-DDThh:mm:ss\u00b1hh of UTC time corresponding to ISO8601 standard.",
"format": "date-time",
"title": "timestamp",
"type": "string"
},
"type": {
"const": "BRDF",
"description": "Data type identifier. Currently always \"BRDF\" that stands for bidirectional reflectance distribution function. Abbreviations for different quantities like spectral and polarimetric BRDF data types will be added in the future versions upon agreement between all stakeholders",
"title": "type",
"type": "string"
}
},
"required": [
"schema",
"id",
"type",
"name",
"timestamp",
"provenance",
"method",
"instrumentation",
"software",
"sample",
"environment"
],
"title": "metadata",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/reference_info_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/reference_info_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing reference sample and related reference BRDF data used for relative BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object that contains user defined keys (not available in \"reference_info\" object) describing any information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The field for providing in a text/string form any additional information relevant to the reference sample and related reference BRDF data used for relative BRDF measurements.",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to any available external information reference sample or reference BRDF data used for relative BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the reference sample used for relative BRDF measurements.",
"title": "dimensions",
"type": "object"
},
"manufacturer": {
"description": "Field for providing manufacturer of the reference sample used for relative BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material from which reference sample used for relative BRDF measurements was made as text (i.e. string). For example \"BaSO4\", \"PTFE\", \"ceramic\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the reference sample that was used for the relative BRDF measurements of data presented within the file (if applicable).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the reference sample that was used for the relative BRDF measurements of data presented within the file.",
"title": "name",
"type": "string"
},
"shape": {
"description": "Shape of the reference sample used for relative BRDF measurements as text (i.e. string). ",
"title": "shape",
"type": "string"
},
"solid_angle": {
"additionalProperties": false,
"description": "An object describing solid angle that was used for reference BRDF data acquisition. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the solid angle that was used for reference BRDF data acquisition as a string that can have values \"sr\".",
"pattern": "sr",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the solid angle that was used for reference BRDF data acquisition as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "solid_angel",
"type": "object"
},
"type": {
"description": "Type of the reference sample used for relative BRDF measurements as text (i.e. string). For example \"white diffuse reflectance standard\", \"colored diffuse reflectance standard\", \"grey diffuse reflectance standard\" etc.",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"solid_angle"
],
"title": "reference_info",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/beam_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/beam_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination beam that cannot be presented within \"aperture\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding illumination beam as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination beam used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"description": "An object describing physical dimensions of the beam at the surface of the measurement sample.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"divergence": {
"additionalProperties": false,
"description": "An object describing divergence of the illumination beam at the surface of the measurement sample.",
"properties": {
"unit": {
"description": "Unit of the divergence of the illumination beam at the surface of the measurement sample. as a string that can have values \"deg\" or \"rad\".",
"enum": [
"deg",
"rad"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the divergence of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with keys \"value\", \"unit\" and/or \"comments\".",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "divergence",
"type": "object"
},
"shape": {
"description": "Shape of the illumination beam at the surface of the measurement sample as a text (i.e. string). For example \"circular\", \"square\", \"rectangular\", \"elliptical\" etc.",
"title": "shape",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing uniformity of the illumination beam at the surface of the measurement sample. It is defined as a ratio of the minimum and maximum optical power values within illumination beam area. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the uniformity of the illumination beam at the surface of the measurement sample as a string that can have values \"%\" or unitless i.e. \"\".",
"pattern": "^%?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the illumination beam at the surface of the measurement sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"shape",
"dimensions"
],
"title": "beam",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | d866db6b4585ac22db103f3579b8ad04a756216b | "2021-11-26T18:53:57" | BRDF_JSON_schema/dimensions_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/dimensions_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing physical dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the dimensions of the different optical elements, illumination beam and/or samples that cannot be presented within \"dimensions\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"area": {
"additionalProperties": false,
"description": "Area of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the area of an optical element, illumination beam and/or sample as a string that can have values \"pm2\", \"nm2\", \"\u03bcm2\", \"mm2\", \"dm2\", \"m2\", \"km2\", \"Mm2\" or \"Gm2\".",
"pattern": "^[GMkmd\u03bcnp]?m2$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the area of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "area",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding dimensions of the different optical elements, illumination beam and/or samples used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"diameter": {
"additionalProperties": false,
"description": "Diameter of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the diameter of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the diameter of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "diameter",
"type": "object"
},
"height": {
"additionalProperties": false,
"description": "Height of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the height of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the height of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "height",
"type": "object"
},
"length": {
"additionalProperties": false,
"description": "Length of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the length of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the length of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "length",
"type": "object"
},
"radius": {
"additionalProperties": false,
"description": "Radius of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the radius of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the radius of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "radius",
"type": "object"
},
"semi_major_axis": {
"additionalProperties": false,
"description": "Semi-major axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-major axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-major axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_major_axis",
"type": "object"
},
"semi_minor_axis": {
"additionalProperties": false,
"description": "Semi-minor axis of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the semi-minor axis of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the semi-minor axis of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "semi_minor_axis",
"type": "object"
},
"thickness": {
"additionalProperties": false,
"description": "Thickness of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the thickness of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the thickness of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "thickness",
"type": "object"
},
"width": {
"additionalProperties": false,
"description": "Width of an optical element, illumination beam and/or sample used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the width of an optical element, illumination beam and/or sample as a string that can have values \"pm\", \"nm\", \"\u03bcm\", \"mm\", \"dm\", \"m\", \"km\", \"Mm\" or \"Gm\".",
"pattern": "^[GMkmd\u03bcnp]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the width of an optical element, illumination beam and/or sample as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "width",
"type": "object"
}
},
"required": [],
"title": "dimensions",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/provenance_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/provenance_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "String or an object with keys describing the origin of the data i.e. institution, address, personell etc. Object has values as a number or a string.",
"properties": {
"comments": {
"description": "Any additional iformation related to the provenance of the presented data in text form.",
"title": "comments",
"type": "string"
},
"contact_person": {
"description": "Name of the contact person representing the organization.",
"title": "contact_person",
"type": "string"
},
"email": {
"description": "Contact email of organization or its contact person. According to RFC 5321, section 4.1.2",
"format": "email",
"title": "email",
"type": "string"
},
"location": {
"additionalProperties": false,
"description": "Object that specifies physical location or address of organization that provided dataset recorded within the file.",
"properties": {
"building_nr": {
"description": "Street number of the building where organization is residing",
"title": "organization",
"type": "string"
},
"city": {
"description": "Name of the city where organization is located",
"title": "organization",
"type": "string"
},
"coordinates": {
"description": "Organization location coordinates according to ISO 6709 standard",
"title": "organization",
"type": "string"
},
"country": {
"description": "Name of the country where organization is located",
"title": "organization",
"type": "string"
},
"county": {
"description": "Name of the county within country where organization is located",
"title": "organization",
"type": "string"
},
"postal_code": {
"description": "Postal code of organization's address.",
"title": "organization",
"type": "string"
},
"room_nr": {
"description": "Laboratory or the room number within the organization's building",
"title": "organization",
"type": "string"
},
"street": {
"description": "Name of the street within city where organization is located",
"title": "organization",
"type": "string"
}
},
"required": [
"country",
"city",
"street",
"building_nr",
"postal_code"
],
"title": "location",
"type": "object"
},
"organization": {
"description": "Name of the company, organization, institution, university etc. that produced the dataset recorded within the file.",
"title": "organization",
"type": "string"
},
"phone": {
"description": "Contact phone/mobile number of organization or its contact person according to notation for international numbers suggested by ITU E.123 standard.",
"title": "phone",
"type": "string"
},
"website": {
"description": "Url of the organization/institution's web-page if available.",
"format": "uri",
"title": "website",
"type": "string"
}
},
"required": [
"organization",
"location",
"email",
"contact_person"
],
"title": "provenance",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/optical_filter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/optical_filter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "The \"optical_filter\" object describes properties of a single optical filter that was used during BRDF measurements. Note that the same object describes optical filters integrated to illumination or detection systems.",
"oneOf": [
{
"required": [
"name",
"type",
"cut_on_wl"
]
},
{
"required": [
"name",
"type",
"cut_off_wl"
]
},
{
"required": [
"name",
"type",
"wl_range"
]
},
{
"required": [
"name",
"type",
"central_wl",
"transmission_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical filter placed in in the path of light of illumination source that cannot be presented within \"filter\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"blocking_avg": {
"additionalProperties": false,
"description": "Average blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "blocking_avg",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "The central transmission wavelength of the of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter central wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"comments": {
"description": "An object that allows to provide any additional information regarding used for BRDF measurements. Array of text (i.e.string) URL links.",
"title": "comments",
"type": "string"
},
"cut_off_wl": {
"additionalProperties": false,
"description": "A cut-off wavelength of an optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter cut-off wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-off wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_off_wl",
"type": "object"
},
"cut_on_wl": {
"additionalProperties": false,
"description": "A cut-on wavelength of an optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter cut-on wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the cut-on wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_on_wl",
"type": "object"
},
"damage_treshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical filter is designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical filter is designed to be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding optical filter used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "material",
"type": "string"
},
"max_blocking": {
"additionalProperties": false,
"description": "Maximal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_blocking"
},
"max_transmission": {
"additionalProperties": false,
"description": "Maximal transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's maximal transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_transmission",
"type": "object"
},
"min_blocking": {
"additionalProperties": false,
"description": "Minimal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_blocking"
},
"min_transmission": {
"additionalProperties": false,
"description": "Minimal transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's minimal transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_transmission",
"type": "object"
},
"model": {
"description": "Model of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "name",
"type": "string"
},
"transmission_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of the spectral transmission range of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's transmission FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's transmission FWHM as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmission_FWHM",
"type": "object"
},
"transmission_avg": {
"additionalProperties": false,
"description": "Average transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's average transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmission_avg",
"type": "object"
},
"type": {
"description": "Type of an optical filter used for BRDF measurements. For example, interference filter, neutral density filter, absorptive filter etc. as a text (i.e.string).",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "The field describing transmission wavelength range of the optical filter used for BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the optical filter's transmission longest wavelength as a number.",
"title": "value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the optical filter's transmission shortest wavelength as a number.",
"title": "value",
"type": "number"
},
"unit": {
"description": "Unit of the optical filter's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "optical_filter",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing a single polarization altering element or an assembly that included to the set-up used for (usually polarimetric) BRDF measurements. Note that the same object describes polarization altering elements integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the polarization altering element included to the of the set-up used for (usually polarimetric) BRDF measurements that cannot be presented within \"polarization_alterant\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements.",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "The field describing maximum power at which polarization altering element can be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximum power at which polarization altering element can be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximum optical power at which polarization altering element can be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum power at which polarization altering element can be operated as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold",
"type": "object"
},
"data_links": {
"description": "An array with links to any relevant technical information regarding polarization altering element included to the set-up used for (usually polarimetric) BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"design_wl": {
"additionalProperties": false,
"description": "An object describing wavelength at which polarization altering element is most effective by design. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength at which polarization altering element is most effective as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength at which polarization altering element is most effective as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength at which polarization altering element is most effective as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "design_wl",
"type": "object"
},
"extinction_ratio": {
"additionalProperties": false,
"description": "The field to describe typical extinction ratio of polarizer used for altering polarization of illumination. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the polarizer's extinction ratio as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Polarizer's extinction ratio uncertainty measurement unit can be expressed as unitless (i.e. empty string \"\"),\"%\" or \"dB\".",
"enum": [
"",
"%",
"dB"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Polarizer's extinction ratio measurement unit can be expressed as unitless (i.e. empty string \"\"),\"%\" and \"dB\".",
"enum": [
"",
"%",
"dB"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the polarizer's extinction ratio as a zero (0) inclusive positive number. Note that extinction ratio is usually presented as X : 1, but since 1 is a constant only X is the value requested here.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_ratio",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the polarization altering element as a text/string.",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Field describing the material of polarization altering element as a text/string.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model name of the polarization altering element given by manufacturer. As a text/string.",
"title": "model",
"type": "string"
},
"name": {
"description": "Short name of an element used for alteration of illumination or detection polarization state. As a text/string.",
"title": "name",
"type": "string"
},
"type": {
"description": "Type of the polarization altering element. For example, \"linear polarizer\", \"quater-wave plate\", \"half-wave plate\", \"retarder\", \"depolarizer\" etc. As a text/string.",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "Wavelength range within which polarization altering element is designed to be operated. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength at which polarization altering element can be used as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of shortest wavelength at which polarization altering element can be used as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the shortest and longest wavelengths at which polarization altering element can be used as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range",
"type": "object"
}
},
"required": [
"name",
"type"
],
"title": "polarization_alterant",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/sensor_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sensor_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing single optical sensor of detection system of the instrument used for BRDF measurements.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical sensor used for BRDF measurements that cannot be presented within \"sensor\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"bias_voltage": {
"additionalProperties": false,
"description": "An object describing bias voltage applied applied to the optical sensor during BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the bias voltage applied applied to the optical sensor as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\" or \"%\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the bias voltage applied applied to the optical sensor as a string that can have values \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\" or \"GV\".",
"enum": [
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the bias voltage applied applied to the optical sensor as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "bias_voltage",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding optical sensor used for BRDF measurements as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical sensor is designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximal optical power at which optical sensor is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximal optical power at which optical sensor is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical sensor is designed to be operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold"
},
"dark_signal": {
"additionalProperties": false,
"description": "An object describing the level of signal when sensor is not exposed to any radiation (in Ampers (A) or Volts (V)). It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical sensor's dark current as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of uncertainty of the the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical sensor's dark current as a string that can have values \"pA\", \"nA\", \"\u03bcA\", \"mA\", \"A\", \"kA\", \"MA\", \"GA\" or \"pV\", \"nV\", \"\u03bcV\", \"mV\", \"V\", \"kV\", \"MV\", \"GV\".",
"enum": [
"pA",
"nA",
"\u03bcA",
"mA",
"A",
"kA",
"MA",
"GA",
"pV",
"nV",
"\u03bcV",
"mV",
"V",
"kV",
"MV",
"GV"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's dark current as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "dark_signal",
"type": "object"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding optical sensor used for BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"dimensions": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/dimensions_json_schema_v1.0.json",
"description": "Dimensions of the photosensitive part of the sensor included in BRDF measurement set-up.",
"required": [
"area"
],
"title": "dimensions",
"type": "object"
},
"linearity": {
"additionalProperties": false,
"description": "An object describing the maximal ratio between responsivities around different optical powers that sensor can sense in case of fixed detection wavelength. It is defined as min_responsivity / max_responsivity for power range used for BRDF measurements. \"nonlinearity\" object has keys keys \"value\" and \"unit\"",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the optical sensor's linearity as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the optical sensor's linearity as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical sensor's linearity as a positive number from 0 to 1 (or 0 to 100 if in \"%\")..",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "linearity",
"type": "object"
},
"linearity_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which linearity of the sensor is provided in the \"linearity\" field/object. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which linearity of the sensor is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which linearity of the sensor is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which linearity of the sensor is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which linearity of the sensor is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity_wl",
"type": "object"
},
"manufacturer": {
"description": "Manufacturer of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Light sensing material used in optical sensor included in BRDF measurement set-up as text (i.e. string). For example \"Si\", \"InGaAs\" etc.",
"title": "material",
"type": "string"
},
"model": {
"description": "Model of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the optical sensor used in BRDF measurement set-up as text (i.e. string).",
"title": "name",
"type": "string"
},
"operating_temperature": {
"additionalProperties": false,
"description": "Field for providing the temperature at which light sensor was operated during BRDF measurements. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"else": {
"properties": {
"value": {
"minimum": 0
}
}
},
"if": {
"properties": {
"unit": {
"const": "\u00b0C"
}
}
},
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the temperature at which light sensor was operated as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\", \"\u00b0C\" or \"%\".",
"enum": [
"K",
"kK",
"\u00b0C",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the temperature at which light sensor was operated as a string that can have values \"K\", \"kK\" or \"\u00b0C\".",
"enum": [
"K",
"kK",
"\u00b0C"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the temperature at which light sensor was operated as a number. In \"\u00b0C\" units the minimum allowed value is \u2212273.15 (i.e. x \u2265 -273.5), while in \"K\" and \"kK\" minimum allowed value is 0 (i.e. x \u2265 0).",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"then": {
"properties": {
"value": {
"minimum": -273.15
}
}
},
"title": "operating_temperature",
"type": "object"
},
"power_range": {
"additionalProperties": false,
"description": "An object describing the optical power range in which optical sensor can be usually applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the highest optical power sensor can detect as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the lowest optical power sensor can detect as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the lowest and highest power that optical sensor can detect as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\"",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "power_range",
"type": "object"
},
"responsivity": {
"additionalProperties": false,
"description": "An object describing typical for the wavelength specified in \"responsivity_wl\" object or average responsivity of optical sensor within the whole spectral response range in A/W. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the typical or average responsivity of optical sensor as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the set typical or average responsivity of optical sensor as a string that can have values \"mA/mW\", \"A/W\" or \"%\".",
"enum": [
"mA/mW",
"A/W",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the set typical or average responsivity of optical sensor as a string that can have values \"mA/mW\" or \"A/W\".",
"enum": [
"mA/mW",
"A/W"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the typical or average responsivity of optical sensor as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity",
"type": "object"
},
"responsivity_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which responsivity of the sensor is provided in the \"responsivity\" field/object. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which responsivity of the sensor is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which responsivity of the sensor is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which responsivity of the sensor is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which responsivity of the sensor is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "responsivity_wl",
"type": "object"
},
"shape": {
"description": "Shape of the photosensitive area of optical sensor included in BRDF measurement set-up as text (i.e. string).",
"title": "shape",
"type": "string"
},
"spectral_response_range": {
"additionalProperties": false,
"description": "An object that specifies wavelength range for sensing of which optical sensor can be applied. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the longest wavelength that optical sensor can sense as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "max_value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the shortest wavelength that optical sensor can sense as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "min_value",
"type": "number"
},
"unit": {
"description": "Measurement unit of the shortest and longest wavelengths that optical sensor can sense as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "spectral_response_range",
"type": "object"
},
"type": {
"description": "Type of the optical sensor used in BRDF measurement set-up as text (i.e. string). For example \"photodiod\", \"CCD-camera\", \"photomultiplyer\" etc.",
"title": "type",
"type": "string"
},
"uniformity": {
"additionalProperties": false,
"description": "An object describing the ratio of minimum and maximum response signals measured at different points of the detector area in case of fixed wavelength and power. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the uniformity of the optical sensor as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the uniformity of the optical sensor as a string that can have values \"%\" or unitless i.e. \"\".",
"enum": [
"",
"%"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the uniformity of the optical sensor as a positive number from 0 to 1 (or 0 to 100 if in \"%\").",
"maximum": 100,
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "uniformity",
"type": "object"
}
},
"required": [
"name",
"spectral_response_range"
],
"title": "sensor",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/monochromator_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object describing properties and set parameters of the monochromator included to the set-up used for (usually spectral) BRDF measurements. Note that the same object describes monochromators integrated to illumination or detection systems.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the monochromator used for illumination or detection light wavelength selection during BRDF measurements that cannot be presented within \"monochromator\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"comments": {
"description": "The section for providing any relevant information regarding monochromator used during BRDF measurements as a string/text.",
"title": "comments",
"type": "string"
},
"damage_threshold": {
"additionalProperties": false,
"description": "Field for indication of maximum optical power at which monochromator was designed to be operated. It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the maximum optical power at which monochromator was designed to be operated without damage as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\", \"GW\" or \"%\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the maximum optical power at which monochromator was designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"enum": [
"pW",
"nW",
"\u03bcW",
"mW",
"W",
"kW",
"MW",
"GW"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximum optical power at which monochromator was designed to be operated without damage as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_threshold",
"type": "object"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding monochromator used during BRDF measurements. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"model": {
"description": "Model of the monochromator used during BRDF measurements. As a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of the monochromator used for BRDF measurements. As a text (i.e.string).",
"title": "name",
"type": "string"
},
"settings": {
"description": "An array with unique objects that describe monochromator settings for a single selected wavelength or different wavelength ranges that were used for BRDF measurements. Array contains unique \"monochromator_setting\" objects.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/monochromator_setting_json_schema_v1.0.json",
"description": "An object describing monochromator parameters for a single selected wavelength or wavelength range within which these parameters were constant during BRDF measurements",
"title": "monochromator_setting",
"type": "object"
},
"title": "settings",
"type": "array",
"uniqueItems": true
},
"type": {
"description": "Type of the monochromator used to select illumination or detection wavelength during BRDF measurements. For example \"prism based monochromatror\", \"double monochromator\" etc. As a text (i.e.string).",
"title": "type",
"type": "string"
}
},
"required": [
"name",
"settings"
],
"title": "monochromator",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 57edfd7a9a2936dbeb39a7e5171be78faf8f9742 | "2021-11-26T20:30:56" | BRDF_JSON_schema/illumination_system_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/illumination_system_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object with keys describing illumination system, illumination source, relevant optical components and illumination beam properties.",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the illumination system of the instrument that cannot be presented within \"illumination\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"aperture": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/aperture_json_schema_v1.0.json",
"description": "An object describing aperture that was used to shape illumination beam for BRDF measurements.",
"title": "aperture",
"type": "object"
},
"beam": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/beam_json_schema_v1.0.json",
"description": "An object with properties describing illumination beam parameters like size, shape, uniformity etc.",
"title": "beam",
"type": "object"
},
"comments": {
"description": "The section that allows to provide any additional information regarding instrument illumination system as a text (i.e.string).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array that allows to refer to available external technical information regarding illumination system used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Field for providing manufacturer of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_manufacturer",
"type": "string"
},
"model": {
"description": "Field for providing model of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_model",
"type": "string"
},
"name": {
"description": "Field for providing name of illumination system used during BRDF measurements as a text (i.e.string).",
"title": "system_name",
"type": "string"
},
"polarization_alterants": {
"description": "The field containing array of objects describing polarization altering elements placed in the path of illumination light used for BRDF measurements.",
"items": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/polarization_alterant_json_schema_v1.0.json",
"description": "An object describing a single polarization altering element or an assembly that was used to produce illumination with desired polarization properties.",
"name": "polarization_alterant",
"type": "object"
},
"title": "polarization_alterants",
"type": "array"
},
"source": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/source_json_schema_v1.0.json",
"description": "An object that describes source of the illumination used for BRDF measurements.",
"title": "source",
"type": "object"
},
"wavelength_selectors": {
"$ref": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/wavelength_selectors_json_schema_v1.0.json",
"description": "An object describing optical components that were used to select specific wavelength or wavelength ranges from illumination source radiation as well as properties and settings of these components.",
"title": "wavelength_selectors",
"type": "object"
}
},
"required": [
"name",
"source",
"beam"
],
"title": "illumination_system",
"type": "object"
} | MIT | en |
BiRD-project/BiRD_view | 3ea1db7afa7841b2d56c04abc3bbc962619465a9 | "2021-12-07T15:41:51" | BRDF_JSON_schema/sample_material_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the specific material from which measurement sample was produced (either partially or fully) that cannot be presented within sample \"material\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"chemical_formula": {
"description": "Chemical formula of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "chemical_formula",
"type": "string"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to the specific material from which measurement sample was produced (either partially or fully).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array with links to any relevant information regarding specific material from which measurement sample was produced (either partially or fully). For example regarding the origin of refractive index and extinction coefficient or relevant transmission, absorption or fluorescence spectra. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"extinction_coefficient": {
"additionalProperties": false,
"description": "An object describing extinction coefficient (or absorption index k) of the material from rom which measurement sample was produced (either partially or fully) and which corresponds to wavelength specified in \"extinction_coefficient_wl\" object. It is an object with following available keys: \"value\", \"uncertainty\" and \"uncertainty_unit\". Note that by definition, extinction coefficient is unitless and current object doesn't have \"units\" object.",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the extinction coefficient (or absorption index k) of the material as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"\" or \"%\"",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"value": {
"description": "Numerical value of the extinction coefficient (or absorption index k) of the material as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient",
"type": "object"
},
"extinction_coefficient_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which extinction coefficient (or absorption index k) of the material is provided in the field \"extinction_coefficient\". It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient_wl",
"type": "object"
},
"layer_number": {
"description": "An integer number that describes the position of the material in the sample structure in case of layered sample composition. Numbering starts from the top surface i.e. from the material that is hit with the illumination first during sample's BRDF measurement. Numbering starts from 1.",
"title": "layer_number",
"type": "integer"
},
"name": {
"description": "Naming of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "name",
"type": "string"
},
"refractive_index": {
"additionalProperties": false,
"description": "An object describing refractive index (n) of the material from which measurement sample was produced (either partially or fully) and which corresponds to wavelength specified in \"refractive_index_wl\" object. It is an object with following available keys: \"value\", \"uncertainty\" and \"uncertainty_unit\". Note that by definition, refractive index is unitless and current object doesn't have \"units\" object.",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the refractive index (n) of the material as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the refractive index (n) of the material is provided as a string that can have values \"\" or \"%\"",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"value": {
"description": "Numerical value of the refractive index (n) of the material as a negative or positive number. Traditionally, it is implied that the minimal possible refractive index is 1 (refractive index of vacuum). However, there are publications that confirm existence of (meta)materials that can have the negative refraction indices (https://en.wikipedia.org/wiki/Negative-index_metamaterial).",
"title": "value",
"type": "number"
}
},
"required": [
"value"
],
"title": "refractive_index",
"type": "object"
},
"refractive_index_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which refractive index (n) of the material is provided in the field \"refractive_index\". It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which refractive index (n) of the material is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which refractive index (n) of the material is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which refractive index (n) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which refractive index (n) of the material is provided as a zero (0) inclusive positive number (x \u2265 0).",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "refractive_index_wl",
"type": "object"
},
"type": {
"description": "Short description of the material's structural role as a string. For example \"main material\", \"substrate\", \"coating\".",
"title": "type",
"type": "string"
}
},
"required": [
"name"
],
"title": "material"
} | MIT | en |
BiRD-project/BiRD_view | 00d7fee1f388f589fc2813376e5889da17e0234a | "2021-12-02T01:06:05" | BRDF_JSON_schema/sample_material_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF_JSON_schema/sample_material_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "An object that describes a single material from which measurement sample was produced (either partially or fully).",
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the specific material from which measurement sample was produced (either partially or fully) that cannot be presented within sample \"material\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"chemical_formula": {
"description": "Chemical formula of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "chemical_formula",
"type": "string"
},
"comments": {
"description": "A section that allows to provide in the form of text (i.e. string) any comments relevant to the specific material from which measurement sample was produced (either partially or fully).",
"title": "comments",
"type": "string"
},
"data_links": {
"description": "An array with links to any relevant information regarding specific material from which measurement sample was produced (either partially or fully). For example regarding the origin of refractive index and extinction coefficient or relevant transmission, absorption or fluorescence spectra. Array contains unique strings formatted as URL links.",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"extinction_coefficient": {
"additionalProperties": false,
"description": "An object describing extinction coefficient (or absorption index k) of the material from rom which measurement sample was produced (either partially or fully) and which corresponds to wavelength specified in \"extinction_coefficient_wl\" object. It is an object with following available keys: \"value\", \"uncertainty\" and \"uncertainty_unit\". Note that by definition, extinction coefficient is unitless and current object doesn't have \"units\" object.",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the extinction coefficient (or absorption index k) of the material as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"\" or \"%\"",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"value": {
"description": "Numerical value of the extinction coefficient (or absorption index k) of the material as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient",
"type": "object"
},
"extinction_coefficient_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which extinction coefficient (or absorption index k) of the material is provided in the field \"extinction_coefficient\". It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which extinction coefficient (or absorption index k) of the material is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "extinction_coefficient_wl",
"type": "object"
},
"layer_number": {
"description": "An integer number that describes the position of the material in the sample structure in case of layered sample composition. Numbering starts from the top surface i.e. from the material that is hit with the illumination first during sample's BRDF measurement. Numbering starts from 1.",
"title": "layer_number",
"type": "integer"
},
"name": {
"description": "Naming of the material from rom which measurement sample was produced (either partially or fully) as a string.",
"title": "name",
"type": "string"
},
"refractive_index": {
"additionalProperties": false,
"description": "An object describing refractive index (n) of the material from which measurement sample was produced (either partially or fully) and which corresponds to wavelength specified in \"refractive_index_wl\" object. It is an object with following available keys: \"value\", \"uncertainty\" and \"uncertainty_unit\". Note that by definition, refractive index is unitless and current object doesn't have \"units\" object.",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the refractive index (n) of the material as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the refractive index (n) of the material is provided as a string that can have values \"\" or \"%\"",
"enum": [
"",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"value": {
"description": "Numerical value of the refractive index (n) of the material as a negative or positive number. Traditionally, it is implied that the minimal possible refractive index is 1 (refractive index of vacuum). However, there are publications that confirm existence of (meta)materials that can have the negative refraction indices (https://en.wikipedia.org/wiki/Negative-index_metamaterial).",
"title": "value",
"type": "number"
}
},
"required": [
"value"
],
"title": "refractive_index",
"type": "object"
},
"refractive_index_wl": {
"additionalProperties": false,
"description": "An object describing wavelength for which refractive index (n) of the material is provided in the field \"refractive_index\". It is an object with following available keys: \"value\", \"unit\", \"uncertainty\" and \"uncertainty_unit\".",
"properties": {
"uncertainty": {
"description": "Numerical value of the uncertainty of the wavelength for which refractive index (n) of the material is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "uncertainty",
"type": "number"
},
"uncertainty_unit": {
"description": "Measurement unit of the uncertainty of the wavelength for which refractive index (n) of the material is provided as a string that can have values \"nm\", \"\u03bcm\" or \"%\".",
"enum": [
"nm",
"\u03bcm",
"%"
],
"title": "uncertainty_unit",
"type": "string"
},
"unit": {
"description": "Measurement unit of the wavelength for which refractive index (n) of the material is provided as a string that can have values \"nm\" or \"\u03bcm\".",
"enum": [
"nm",
"\u03bcm"
],
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the wavelength for which refractive index (n) of the material is provided as a zero (0) inclusive positive number.",
"minimum": 0,
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "refractive_index_wl",
"type": "object"
},
"type": {
"description": "Short description of the material's structural role as a string. For example \"main material\", \"substrate\", \"coating\".",
"title": "type",
"type": "string"
}
},
"required": [
"name"
],
"title": "material"
} | MIT | en |
BiRD-project/BiRD_view | 31e35774b25eec52bec163134057f332b039a7b5 | "2021-11-25T21:59:18" | BRDF_JSON_schema/optical_filter_json_schema_v1.0.json | 10 | 2024-05-28T04:46:14.181921Z | {
"$id": "https://raw.githubusercontent.com/BiRD-project/BiRD_view/master/BRDF JSON schema/optical_filter_json_schema_v1.0.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "The \"optical_filter\" object describes properties of a single optical filter that was used during BRDF measurements. Note that the same object describes optical filters integrated to illumination or detection systems.",
"oneOf": [
{
"required": [
"name",
"type",
"cut_on_wl"
]
},
{
"required": [
"name",
"type",
"cut_off_wl"
]
},
{
"required": [
"name",
"type",
"wl_range"
]
},
{
"required": [
"name",
"type",
"central_wl",
"transmission_FWHM"
]
}
],
"properties": {
"adhoc_section": {
"description": "An object containing user defined keys describing any information relevant to the optical filter placed in in the path of light of illumination source that cannot be presented within \"filter\" object properties provided by schema. Adhoc section can contain all types of entries.",
"title": "adhoc_section",
"type": "object"
},
"blocking_avg": {
"additionalProperties": false,
"description": "Average blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's average blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "blocking_avg",
"type": "object"
},
"central_wl": {
"additionalProperties": false,
"description": "The central transmission wavelength of the of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter central wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter central wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "central_wl",
"type": "object"
},
"comments": {
"description": "An object that allows to provide any additional information regarding used for BRDF measurements. Array of text (i.e.string) URL links.",
"title": "comments",
"type": "string"
},
"cut_off_wl": {
"additionalProperties": false,
"description": "A cut-off wavelength of an optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter cut-off wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter cut-off wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_off_wl",
"type": "object"
},
"cut_on_wl": {
"additionalProperties": false,
"description": "A cut-on wavelength of an optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter cut-on wavelength as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the cut-on wavelength as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "cut_on_wl",
"type": "object"
},
"damage_treshold": {
"additionalProperties": false,
"description": "Field describing maximal optical power at which optical filter is designed to be operated. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the maximal optical power at which optical filter is designed to be operated as a string that can have values \"pW\", \"nW\", \"\u03bcW\", \"mW\", \"W\", \"kW\", \"MW\" or \"GW\".",
"pattern": "^[pn\u03bcmkMG]?W$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the maximal optical power at which optical filter is designed to be operated as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "damage_treshold"
},
"data_links": {
"description": "An object that allows to refer to available external technical information regarding optical filter used for BRDF measurements. Array of URL links as a text (i.e.string).",
"items": {
"format": "uri",
"type": "string"
},
"title": "data_links",
"type": "array",
"uniqueItems": true
},
"manufacturer": {
"description": "Manufacturer of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "manufacturer",
"type": "string"
},
"material": {
"description": "Material of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "material",
"type": "string"
},
"max_blocking": {
"additionalProperties": false,
"description": "Maximal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's maximal blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_blocking"
},
"max_transmission": {
"additionalProperties": false,
"description": "Maximal transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's maximal transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's maximal transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "max_transmission",
"type": "object"
},
"min_blocking": {
"additionalProperties": false,
"description": "Minimal blocking/absorption value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's minimal blocking/absorption as a string that can have value \"OD\" (optical density).",
"pattern": "OD$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal blocking/absorption value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_blocking"
},
"min_transmission": {
"additionalProperties": false,
"description": "Minimal transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's minimal transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's minimal transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "min_transmission",
"type": "object"
},
"model": {
"description": "Model of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "model",
"type": "string"
},
"name": {
"description": "Name of an optical filter used for BRDF measurements as a text (i.e.string).",
"title": "name",
"type": "string"
},
"transmission_FWHM": {
"additionalProperties": false,
"description": "Full Width at Half Maximum of the spectral transmission range of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's transmission FWHM as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[n\u03bc]?m$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's transmission FWHM as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmission_FWHM",
"type": "object"
},
"transmission_avg": {
"additionalProperties": false,
"description": "Average transmission value of the optical filter used for BRDF measurements. It is an object with keys \"value\" and \"unit\".",
"properties": {
"unit": {
"description": "Unit of the optical filter's average transmission value as a string that can have values \"%\" or \"\" i.e. unitless.",
"pattern": "^[%]?$",
"title": "unit",
"type": "string"
},
"value": {
"description": "Numerical value of the optical filter's average transmission value as a number.",
"title": "value",
"type": "number"
}
},
"required": [
"value",
"unit"
],
"title": "transmission_avg",
"type": "object"
},
"type": {
"description": "Type of an optical filter used for BRDF measurements. For example, interference filter, neutral density filter, absorptive filter etc. as a text (i.e.string).",
"title": "type",
"type": "string"
},
"wl_range": {
"additionalProperties": false,
"description": "The field describing transmission wavelength range of the optical filter used for BRDF measurements. It is an object with keys \"min_value\", \"max_value\" and \"unit\".",
"properties": {
"max_value": {
"description": "Numerical value of the optical filter's transmission longest wavelength as a number.",
"title": "value",
"type": "number"
},
"min_value": {
"description": "Numerical value of the optical filter's transmission shortest wavelength as a number.",
"title": "value",
"type": "number"
},
"unit": {
"description": "Unit of the optical filter's transmission shortest and longest wavelengths as a string that can have values \"nm\" or \"\u03bcm\".",
"pattern": "^[\u03bcn]?m$",
"title": "unit",
"type": "string"
}
},
"required": [
"min_value",
"max_value",
"unit"
],
"title": "wl_range"
}
},
"title": "optical_filter",
"type": "object"
} | MIT | en |