xan/awips2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
awips2/pythonPackages/scientific/Doc/Reference/Scientific.Geometry.Objects3D.RhombicLattice-class.html
root 2c3569dd39 Initial revision of AWIPS2 11.9.0-7p5 
Former-commit-id: 2b462d8665 [formerly 133dc97f67] [formerly a02aeb236c] [formerly a02aeb236c [formerly 9f19e3f712]] [formerly 06a8b51d6d [formerly a02aeb236c [formerly 9f19e3f712] [formerly 06a8b51d6d [formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]]]
Former-commit-id: 06a8b51d6d
Former-commit-id: e2ecdcfe33 [formerly 377dcd10b9] [formerly 8e80217e59 [formerly 3360eb6c5f]]
Former-commit-id: 8e80217e59
Former-commit-id: 9bb8decbcf
2012-01-06 08:55:05 -06:00

248 lines
10 KiB
HTML
Executable file
Raw Blame History

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Scientific.Geometry.Objects3D.RhombicLattice</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Scientific-module.html">Package&nbsp;Scientific</a> ::
<a href="Scientific.Geometry-module.html">Package&nbsp;Geometry</a> ::
<a href="Scientific.Geometry.Objects3D-module.html">Module&nbsp;Objects3D</a> ::
Class&nbsp;RhombicLattice
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Scientific.Geometry.Objects3D.RhombicLattice-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class RhombicLattice</h1><p class="nomargin-top"></p>
<pre class="base-tree">
<a href="Scientific.Geometry.Objects3D.Lattice-class.html">Lattice</a> --+
|
<strong class="uidshort">RhombicLattice</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Scientific.Geometry.Objects3D.BravaisLattice-class.html">BravaisLattice</a></li> </ul>
</dd></dl>
<hr />
<p>Lattice with rhombic elementary cell</p>
<p>A lattice object contains values defined on a finite periodic
structure that is created by replicating a given elementary cell along
the three lattice vectors. The elementary cell can contain any number of
points.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.Geometry.Objects3D.RhombicLattice-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">elementary_cell</span>,
<span class="summary-sig-arg">lattice_vectors</span>,
<span class="summary-sig-arg">cells</span>,
<span class="summary-sig-arg">function</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="makeLattice"></a><span class="summary-sig-name">makeLattice</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">elementary_cell</span>,
<span class="summary-sig-arg">lattice_vectors</span>,
<span class="summary-sig-arg">cells</span>,
<span class="summary-sig-arg">base</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Scientific.Geometry.Objects3D.Lattice-class.html">Lattice</a></code></b>:
<code><a href="Scientific.Geometry.Objects3D.Lattice-class.html#__getitem__">__getitem__</a></code>,
<code><a href="Scientific.Geometry.Objects3D.Lattice-class.html#__len__">__len__</a></code>,
<code><a href="Scientific.Geometry.Objects3D.Lattice-class.html#__setitem__">__setitem__</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">elementary_cell</span>,
<span class="sig-arg">lattice_vectors</span>,
<span class="sig-arg">cells</span>,
<span class="sig-arg">function</span>=<span class="sig-default">None</span>,
<span class="sig-arg">base</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>elementary_cell</code></strong> (<code>list</code> of <a
href="Scientific.Geometry.Vector-class.html"
class="link">Scientific.Geometry.Vector</a>) - a list of the points in the elementary cell</li>
<li><strong class="pname"><code>lattice_vectors</code></strong> (<code>tuple</code> of three <a
href="Scientific.Geometry.Vector-class.html"
class="link">Scientific.Geometry.Vector</a>) - the edges of the elementary cell</li>
<li><strong class="pname"><code>cells</code></strong> - a tuple of three integers, indicating how often the elementary
cell should be replicated along each lattice vector</li>
<li><strong class="pname"><code>cells</code></strong> - <code>tuple</code> of <code>int</code></li>
<li><strong class="pname"><code>function</code></strong> (callable) - the function to be applied to each point in the lattice in order
to obtain the value stored in the lattice. If no function is
specified, the point itself becomes the value stored in the
lattice.</li>
<li><strong class="pname"><code>base</code></strong> (<a href="Scientific.Geometry.Vector-class.html"
class="link">Scientific.Geometry.Vector</a>) - an offset added to all lattice points</li>
</ul></dd>
<dt>Overrides:
<a href="Scientific.Geometry.Objects3D.Lattice-class.html#__init__">Lattice.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Scientific-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0 on Tue Oct 28 14:16:04 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink