RaysOutput

class qdflow.generate.RaysOutput(physics=<factory>, centers=<factory>, rays=<factory>, resolution=0, sensor=<factory>, are_dots_occupied=<factory>, are_dots_combined=<factory>, dot_charges=<factory>, converged=None, dot_transitions=None, are_transitions_combined=None, excited_sensor=None, current=None)

Bases: object

Output of ray data calculations. Some attributes may be None depending on which quantities are calculated.

Parameters:

  • physics (PhysicsParameters) – The set of physics parameters used in the simulation.

  • centers (ndarray[float]) – An array with shape (n_centers, n_dots) indicating the points from which rays should start.

  • rays (ndarray[float]) – An array with shape (n_rays, n_dots) indicating the direction and length of from each ray that extends from a single center point.

  • resolution (int) – The number of points per ray to simulate.

  • sensor (ndarray[float]) – An array with shape (n_centers, n_rays, resolution, n_sensors) giving the Coulomb potential at each point at a specific sensor.

  • are_dots_occupied (ndarray[bool]) – An array with shape (n_centers, n_rays, resolution, n_dots), indicating whether each dot is occupied at each point.

  • are_dots_combined (ndarray[bool]) – An array with shape (n_centers, n_rays, resolution, n_dots-1), indicating at each point, whether the dots on each side of an internal barrier are combined together (i.e. the barrier is too low).

  • dot_charges (ndarray[int]) – An array with shape (n_centers, n_rays, resolution, n_dots), indicating the total number of charges in each dot at each point. In the case of combined dots, the total number of charges will be entered in the left-most spot, with the other spots padded with zeros.

  • converged (ndarray[bool] or None) – An array with shape (n_centers, n_rays, resolution), indicating whether the calculation of n(x) properly converged at each point.

  • dot_transitions (ndarray[bool] or None) – An array with shape (n_centers, n_rays, resolution, n_dots), indicating whether a transition in each dot occurs at each pixel in the diagram.

  • are_transitions_combined (ndarray[bool] or None) – An array with shape (n_centers, n_rays, resolution, n_dots-1), indicating at each point, whether a transition occurs on a combined dot comprised of dots on either side of each internal barrier.

  • excited_sensor (ndarray[float] or None) – An array with shape (n_centers, n_rays, resolution, n_sensors) giving the Coulomb potential in an excited state at each point for a specific sensor.

  • current (ndarray[float] or None) – An array with shape (n_centers, n_rays, resolution) giving the current across the nanowire at each point.

__init__(physics=<factory>, centers=<factory>, rays=<factory>, resolution=0, sensor=<factory>, are_dots_occupied=<factory>, are_dots_combined=<factory>, dot_charges=<factory>, converged=None, dot_transitions=None, are_transitions_combined=None, excited_sensor=None, current=None)

Methods

copy()

Creates a copy of a RaysOutput object.

from_dict(d)

Creates a new RaysOutput object from a dict of values.

to_dict()

Converts the RaysOutput object to a dict.