4. The Raith_structure class

Class overview: Raith_structure

Properties (public)
`Raith_structure.name`	Character array specifying name of structure
`Raith_structure.elements`	Array of `Raith_element` objects in structure

Properties (private set access)
`Raith_structure.reflist`	Cell array of referenced structure names

Methods
`Raith_structure.plot()`	Plot structure as filled polygons
`Raith_structure.plotedges()`	Plot structure as unfilled polygons

class Raith_structure

Raith_structure objects define named structures composed of low-level elements (Raith_element objects). Structures are packaged together in a GDSII hierarchy (library), and are the objects referred to in positionlist entries.

4.1. Properties

4.1.1. Public properties

Raith_structure.name: Character array specifying name of structure. Maximum length is 127 characters. Allowed characters are A–Z, a–z, 0–9, underscore (_), period (.), dollar sign ($), question mark (?), and hyphen (-).[1]

Raith_structure.elements: Array of Raith_element objects in structure. Raith_element arrays are created using standard MATLAB notation.

4.1.2. Private set-access properties

Raith_structure.reflist: Cell array of structure names (character arrays) referenced by 'sref' or 'aref' elements within the structure. reflist is automatically updated whenever elements is amended.

4.2. Constructor

Constructor:

S=Raith_structure(name,elements)

Arguments:

name – Character array specifying name of structure. Maximum length is 127 characters. Allowed characters are A–Z, a–z, 0–9, underscore (_), period (.), dollar sign ($), question mark (?), and hyphen (-). Illegal characters are replaced with underscores (with a warning issued).
elements – Array of Raith_element objects in structure. Raith_element arrays are created using standard MATLAB notation (see following Example).

Example

% Optical racetrack resonator
E(1)=Raith_element('arc',0,[2 0],3,[-90 90],0,0.3,200,1.3);
E(2)=Raith_element('arc',0,[-2 0],3,[90 270],0,0.3,200,1.3);
E(3)=Raith_element('path',0,[-2 2;3 3],0.3,1.3);
E(4)=Raith_element('path',0,[-2 2;-3 -3],0.3,1.3);
S=Raith_structure('racetrack',E);

4.3. Methods

Raith_structure.plot([M[, scDF]])

Plot Raith_structure object with default Raith dose factor colouring. Elements are displayed as filled polygons, where applicable ('polygon'; 'path' with non-zero data.w; 'arc', 'circle', and 'ellipse' with empty data.w; 'text'). All elements in the structure are plotted, regardless of data.layer value.

Arguments:

M – Augmented transformation matrix to be applied to structure [optional]; see Raith_library.trans(), Raith_library.rot(), Raith_library.refl(), and Raith_library.scale().
scDF – Overall multiplicative scaling factor applied to dose factors of all elements in structure [optional]

Returns:

None

Calling Raith_structure.plot() does not change the current axis scaling; issue an axis equal command to ensure that the structure is displayed in the figure correctly.

Note

Normally, Raith_structure.plot() is called without arguments, to display the Raith_structure object as it would appear in the Raith NanoSuite software. The optional arguments M and scDF are used internally, when Raith_structure.plot() is called by Raith_library.plot() or Raith_positionlist.plot().

Example

Given the Raith_structure object S defined in the above Constructor section:

S.plot;
axis equal;

_images/RS_plot.svg — Fig. 4.1 Racetrack resonator structure plotted using the `Raith_structure.plot()` method

Raith_structure.plotedges([M[, scDF]])

Plot Raith_structure object outlines with default Raith dose factor colouring. Elements are displayed as unfilled polygons, where applicable ('polygon'; 'path' with non-zero data.w; 'arc', 'circle', and 'ellipse' with empty data.w; 'text'). All elements in the structure are plotted, regardless of data.layer value.

Arguments:

M – Augmented transformation matrix to be applied to structure [optional]; see Raith_library.trans(), Raith_library.rot(), Raith_library.refl(), and Raith_library.scale().
scDF – Overall multiplicative scaling factor applied to dose factors of all elements in structure [optional]

Returns:

None

Calling Raith_structure.plotedges() does not change the current axis scaling; issue an axis equal command to ensure that the structure is displayed in the figure correctly.

Note

Normally, Raith_structure.plotedges() is called without arguments, to display the Raith_structure object as it would appear in the Raith NanoSuite software. The optional arguments M and scDF are used internally, when Raith_structure.plotedges() is called by Raith_library.plotedges() or Raith_positionlist.plotedges().

Example

Given the Raith_structure object S defined in the above Constructor section:

S.plotedges;
axis equal;

_images/RS_plotedges.svg — Fig. 4.2 Racetrack resonator structure plotted using the `Raith_structure.plotedges()` method