Add and use `itk::ImageBase::AllocateInitialized()`

[N-Dekker]

The existing three possible ways to call Allocate(bool = false) (either by Allocate(true), Allocate(false), or Allocate()) may accidentally be confused, especially by novice ITK users.

The proposed AllocateZeroInitializedPixelBuffer() is intended to reduce the chance of such a confusion, and improve code readability. It is equivalent to Allocate(true).

---

For the record, "AllocateZeroInitializedPixelBuffer" was renamed to "AllocateInitialized", as suggested at https://github.com/InsightSoftwareConsortium/ITK/pull/4479#issuecomment-1964624698

[N-Dekker]

/azp run

[blowekamp]

I find the member function name over verbose.

[dzenanz]

AllocateInitialized for the name? Docstring should have sufficient explanation about default values.

[N-Dekker]

AllocateInitialized for the name?

Thanks for the suggestion @dzenanz. However, I would like the name to be self-explanatory. Until now it was a common practice to add a comment to actually explain the meaning of Allocate(true) with each Allocate(true) call. For example:

m_TemporaryPointer->Allocate(true); // initialize buffer to zero

https://github.com/InsightSoftwareConsortium/ITK/blob/adcc46bf9600b78bda422c49a8aca4611c1751d1/Modules/Core/Common/include/itkFloodFilledFunctionConditionalConstIterator.hxx#L86

So do you (both) think the name AllocateInitialized is sufficiently self-explanatory? So that most people won't feel the need to look up the meaning, or add a comment like "initialize buffer to zero"?

[blowekamp]

So do you (both) think the name AllocateInitialized is sufficiently self-explanatory? So that most people won't feel the need to look up the meaning, or add a comment like "initialize buffer to zero"?

I think the name is sufficient 👍