tidy3d.Coords
tidy3d.Coords#
- class tidy3d.Coords#
Holds data about a set of x,y,z positions on a grid.
- Parameters
x (Array) – 1-dimensional array of x coordinates.
y (Array) – 1-dimensional array of y coordinates.
z (Array) – 1-dimensional array of z coordinates.
Example
>>> x = np.linspace(-1, 1, 10) >>> y = np.linspace(-1, 1, 11) >>> z = np.linspace(-1, 1, 12) >>> coords = Coords(x=x, y=y, z=z)
Show JSON schema
{ "title": "Coords", "description": "Holds data about a set of x,y,z positions on a grid.\n\nParameters\n----------\nx : Array\n 1-dimensional array of x coordinates.\ny : Array\n 1-dimensional array of y coordinates.\nz : Array\n 1-dimensional array of z coordinates.\n\nExample\n-------\n>>> x = np.linspace(-1, 1, 10)\n>>> y = np.linspace(-1, 1, 11)\n>>> z = np.linspace(-1, 1, 12)\n>>> coords = Coords(x=x, y=y, z=z)", "type": "object", "properties": { "x": { "title": "Array Like", "description": "Accepts sequence (tuple, list, numpy array) and converts to tuple.", "type": "tuple", "properties": {}, "required": [] }, "y": { "title": "Array Like", "description": "Accepts sequence (tuple, list, numpy array) and converts to tuple.", "type": "tuple", "properties": {}, "required": [] }, "z": { "title": "Array Like", "description": "Accepts sequence (tuple, list, numpy array) and converts to tuple.", "type": "tuple", "properties": {}, "required": [] }, "type": { "title": "Type", "default": "Coords", "enum": [ "Coords" ], "type": "string" } }, "required": [ "x", "y", "z" ], "additionalProperties": false }
- attribute x: tidy3d.components.types.Array [Required]#
1-dimensional array of x coordinates.
- Constraints
title = Array Like
description = Accepts sequence (tuple, list, numpy array) and converts to tuple.
type = tuple
properties = {}
required = []
- attribute y: tidy3d.components.types.Array [Required]#
1-dimensional array of y coordinates.
- Constraints
title = Array Like
description = Accepts sequence (tuple, list, numpy array) and converts to tuple.
type = tuple
properties = {}
required = []
- attribute z: tidy3d.components.types.Array [Required]#
1-dimensional array of z coordinates.
- Constraints
title = Array Like
description = Accepts sequence (tuple, list, numpy array) and converts to tuple.
type = tuple
properties = {}
required = []
- property to_dict#
Return a dict of the three Coord1D objects as numpy arrays.
- property to_list#
Return a list of the three Coord1D objects as numpy arrays.