File tree Expand file tree Collapse file tree 1 file changed +11
-6
lines changed Expand file tree Collapse file tree 1 file changed +11
-6
lines changed Original file line number Diff line number Diff line change @@ -1588,17 +1588,22 @@ def ndim(self):
1588
1588
1589
1589
def lazy_data (self ):
1590
1590
"""
1591
- Return a lazy array representing the Cube data.
1591
+ Return a "lazy array" representing the Cube data. A lazy array
1592
+ describes an array whose data values have not been loaded into memory
1593
+ from disk.
1592
1594
1593
- Accessing this method will never cause the data to be loaded.
1595
+ Accessing this method will never cause the Cube data to be loaded.
1594
1596
Similarly, calling methods on, or indexing, the returned Array
1595
- will not cause the Cube to have loaded data .
1597
+ will not cause the Cube data to be loaded.
1596
1598
1597
- If the data have already been loaded for the Cube, the returned
1598
- Array will be a new lazy array wrapper.
1599
+ If the Cube data have already been loaded (for example by calling
1600
+ :meth:`~iris.cube.Cube.data`), the returned Array will be a view of the
1601
+ loaded cube data represented as a lazy array object. Note that this
1602
+ does _not_ make the Cube data lazy again; the Cube data remains loaded
1603
+ in memory.
1599
1604
1600
1605
Returns:
1601
- A lazy array, representing the Cube data array .
1606
+ A lazy array, representing the Cube data.
1602
1607
1603
1608
"""
1604
1609
return self ._data_manager .lazy_data ()
You can’t perform that action at this time.
0 commit comments